compositr/luciders
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: add readme

Browse source
This commit is contained in:
Compositr 2024-11-02 18:25:01 +11:00
parent 8eb50483b2
commit 9c78d4d94e
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# `luciders` Server
Dynamically serving up [lucide](https://lucide.dev) icons. Powered by 🦀 Rust!
Please see `/info` endpoint handler in `src/main.rs` for more API details.
# Setup Instructions
You will want a copy of the `icons` dir from the Lucide [Github Repo](https://github.com/lucide-icons/lucide) in the root of this project. If you are developing this project, you can simply clone the configured submodule:
```bash
git submodule update --init --recursive
```
If you are deploying to production, you can provide a directory path in the first argument to the binary. For example, if you have the icons in `/var/www/icons`:
```bash
./luciders /var/www/icons
```
Only `.svg` files will be read from that directory. The server's default port is `7878`, although this can be configured with the `PORT` environment variable.