Add current status to README
This commit is contained in:
parent
d2edb119d9
commit
859895e75a
1 changed files with 25 additions and 1 deletions
26
README.md
26
README.md
|
@ -2,4 +2,28 @@
|
||||||
|
|
||||||
Drift is a self-hostable Gist clone. It's also a major work-in-progress, but is (almost, no database yet) completely functional.
|
Drift is a self-hostable Gist clone. It's also a major work-in-progress, but is (almost, no database yet) completely functional.
|
||||||
|
|
||||||
You can try a demo at https://drift.maxleiter.com
|
You can try a demo at https://drift.maxleiter.com. The demo is built on master but has no database, so files and accounts can be wiped at any time.
|
||||||
|
|
||||||
|
If you want to contribute, need support, or want to stay updated, you can join the IRC channel at #drift on irc.libera.chat or [follow me on twitter](https://twitter.com/Max_Leiter). If you don't have an IRC client yet, you can use a webclient [here](https://demo.thelounge.chat/#/connect?join=%23drift&nick=drift-user&realname=Drift%20User).
|
||||||
|
|
||||||
|
## Current status
|
||||||
|
Drit is a major work in progress. Below is a (rough) list of completed and envisioned features. If you want to help address any of them, please let me know regardless of your experience and I'll be happy to assist.
|
||||||
|
|
||||||
|
- [x] creating and sharing private, public, unlisted posts
|
||||||
|
- [x] syntax highlighting (detected by file extension)
|
||||||
|
- [x] multiple files per post
|
||||||
|
- [ ] uploading files via drag-and-drop
|
||||||
|
- [x] responsive UI
|
||||||
|
- [x] user auth
|
||||||
|
- [ ] SSO via HTTP header (Issue: [#11](https://github.com/MaxLeiter/Drift/issues/11))
|
||||||
|
- [ ] downloading files (individually and entire posts)
|
||||||
|
- [ ] password protected posts
|
||||||
|
- [ ] sqlite database (should be very easy to set-up; the ORM is just currently set to memory for ease of development)
|
||||||
|
- [ ] non-node backend
|
||||||
|
- [ ] administrator account / settings
|
||||||
|
- [ ] docker-compose (PR: [#13](https://github.com/MaxLeiter/Drift/pull/13))
|
||||||
|
- [ ] publish docker builds
|
||||||
|
- [ ] user settings
|
||||||
|
- [ ] works enough with JavaScript disabled
|
||||||
|
- [ ] documentation
|
||||||
|
- [ ] customizable homepage, so the demo can exist as-is but other instances can be built from the same source. Environment variable for the file contents?
|
||||||
|
|
Loading…
Reference in a new issue