Musselman/notatio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📝 Docs: Update README spelling and project details

Browse source 
Remove spelling errors, add missing env variables, no longer in capstone
This commit is contained in:
James Musselman 2024-06-26 09:55:27 -05:00
parent 74bacfa0f0
commit 3461144e69
Signed by: Musselman
GPG key ID: 1DAEFF35ECB5D6DB
1 changed files with 8 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -4,7 +4,7 @@
**Notatio is currently under heavy development, and as such there is the possibility breaking changes**
Notatio is a self-hostable, containerized, web-based text editor. The main objective of the project is to create a platform independent text editor (and productivity management suite). I hope to develop this as an alterniative to propriatry software like obsidian and Notion.so which I have loved and used in the past. This software is currently being created as part of a Senior Capstone, but there are plans to continue developing it afterwards.
Notatio is a self-hostable, containerized, web-based text editor. The main objective of the project is to create a platform independent text editor (and productivity management suite). I hope to develop this as an alternative to proprietary software like obsidian and Notion.so which I have loved and used in the past. This software was originally created as part of a Senior Capstone, but is now being developed in my spare time while job hunting.
## 🛣️ **Roadmap**
@ -19,14 +19,14 @@ Notatio is a self-hostable, containerized, web-based text editor. The main objec
- [ ] Flesh out File Management Operations
- [ ] NoSQL setup option
#### Planned V1.1 Release
#### Planned v1.1 Release
- [ ] Collaborative Editing
- [ ] File Versiong
- [ ] File Versioning
#### Planned v1.2 Releaase
#### Planned v1.2 Release
- [ ] End to End Encryption
- [ ] End-to-End Encryption
@ -42,7 +42,7 @@ git clone https://codeberg.org/musselman/notatio
There are two ways to run Notatio.
### 📦**Container (Recommended)**
### 📦 Container (Recommended)**
---
@ -87,16 +87,14 @@ To run Notatio using the Go binary, follow the steps below:
Example command:
```bash
DB_HOST=127.0.0.1 PGPORT=5432 DB_USER=postgres POSTGRES_PASSWORD=mysecretpassword DB_SSL_MODE=disable ADMIN_USER=admin_user ADMIN_PASS=admin_is_not_a_good_password! ./notatio
DB_HOST=127.0.0.1 PGPORT=5432 DB_USER=postgres POSTGRES_PASSWORD=mysecretpassword DB_SSL_MODE=disable ADMIN_USER=admin_user ADMIN_NAME=Admin ADMIN_EMAIL=admin@example.com ADMIN_PASS=admin_is_not_a_good_password! ./notatio
```
Please note that this method is more advanced and requires additional setup.
## 🤝 Contributing
As this is currently an accademic project I cannot accept contributions! If you are interested in doing so please reach out to me on or after December 7th.
<!---All contributions are welcome. Please take a look at [contributing](./CONTRIBUTING.md) guide. -->
As this is no longer an academic project, All contributions are welcome. Please take a look at [contributing](./CONTRIBUTING.md) guide.
## 📄 License