From 9c78d4d94ef4e21b47febc58e0a8103df2c0844d Mon Sep 17 00:00:00 2001 From: Compositr Date: Sat, 2 Nov 2024 18:25:01 +1100 Subject: [PATCH] chore: add readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..dc03f00 --- /dev/null +++ b/README.md @@ -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.