Skip to content

Commit 0255502

Browse files
Update README.md
1 parent 7577877 commit 0255502

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
1-
# slate
1+
<div align="center">
22

3-
A flexible document management interface for educators and learners.
3+
# Slate
44

5-
## Recommended IDE Setup
5+
![Electron.js](https://img.shields.io/badge/Electron-191970?style=for-the-badge&logo=Electron&logoColor=white)
6+
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
7+
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
8+
![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)
69

7-
- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
10+
A flexible document management interface for educators and learners.
11+
12+
[Features](#features)
13+
[Installation](#installation)
14+
[Examples](#examples)
15+
16+
</div>
17+
18+
## Features
819

9-
## Project Setup
20+
- Integrates with existing filesystems, Google Drive, and Dropbox.
21+
- Drag-and-drop file organization and live preview.
22+
- Groups files by designated classes and types.
23+
- Displays weekly and monthly explorer views.
24+
25+
## Installation
26+
27+
### Recommended IDE Setup
28+
29+
- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
1030

1131
### Install
1232

@@ -32,3 +52,5 @@ $ npm run build:mac
3252
# For Linux
3353
$ npm run build:linux
3454
```
55+
## Examples
56+
<sup>[(Back to top)](#slate)</sup>

0 commit comments

Comments
 (0)