diff --git a/README.md b/README.md index 601507b..b05da9c 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,31 @@ return site ``` This can be ran with `fes run .` where `.` is the location of the Fes.toml + +## Examples + +See `examples/` for different features, `canonical/` contains the best practices for this microframework. + +## Build + +```sh +git clone https://git.vxserver.dev/fSD/fes.git +cd fes + +go build . +./fes run examples/hello-world # if this works install + +go install fes +``` + +## Documentation + +Run `fes run doc` for the documentation website or goto [docs.vxserver.dev](https://docs.vxserver.dev) + +## License + +ISC License + +Copyright (C) 2025 fSD + +See `COPYING` \ No newline at end of file