changed readme
This commit is contained in:
14
README.md
14
README.md
@@ -8,9 +8,12 @@ The code has been minimally touched by AI in the form of helping me figure out t
|
||||
To reduce the 404s I also generated the favicon.
|
||||
|
||||
### Usage
|
||||
Copy the executable and the config.json to the same directory and run
|
||||
Download the latest release.
|
||||
Extract to an empty directory and run.
|
||||
You may want to change the configuration as needed.
|
||||
|
||||
Syncing of the TeX files is not handled by ServTeX. Use syncthing, rsync or whatever else you want.
|
||||
|
||||
### Development
|
||||
```go
|
||||
go build
|
||||
@@ -18,3 +21,12 @@ go build
|
||||
```
|
||||
or `make`, which contains the same.
|
||||
|
||||
### Help Wanted
|
||||
Some nice to have features are missing. Feel free to open an issue if you want to tackle them or propose a new feature.
|
||||
- Multi user support
|
||||
- Basic Authentication / OAuth
|
||||
- Configurable per-user rate limiting
|
||||
- Embedded PDF viewer that is more suitable for this than a browser
|
||||
- Obsidian.md plugin including the syncing logic on both ends
|
||||
- Better UI (me no frontend guy)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user