chore: update readme
This commit is contained in:
parent
543cedc273
commit
8e4e5dcf63
1 changed files with 12 additions and 0 deletions
12
README.md
12
README.md
|
@ -1,6 +1,8 @@
|
|||
# `luciders` Server
|
||||
Dynamically serving up [lucide](https://lucide.dev) icons. Powered by 🦀 Rust!
|
||||
|
||||
This project is focuses on minimising resource usage and maximising performance. It is designed to be run on a server and used as an API endpoint for other projects rather than being a standalone application.
|
||||
|
||||
Please see `/info` endpoint handler in `src/main.rs` for more API details.
|
||||
|
||||
# Setup Instructions
|
||||
|
@ -18,6 +20,16 @@ If you are deploying to production, you can provide a directory path in the firs
|
|||
|
||||
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.
|
||||
|
||||
# Docker
|
||||
You can build and run this project with Docker. The Dockerfile is configured to use the submodule for the icons. To build the image:
|
||||
|
||||
```bash
|
||||
git submodule update --init --recursive # Update the submodule if you haven't already
|
||||
docker build -t luciders . # Build Docker image
|
||||
```
|
||||
|
||||
Port `7878` is exposed by default.
|
||||
|
||||
# License
|
||||
Please see the `LICENSE.md` file in this directory. This project is licensed under the AGPL-3.0 license.
|
||||
|
||||
|
|
Loading…
Reference in a new issue