docs: update README

This commit is contained in:
Daylin Morgan 2023-11-25 02:21:45 -06:00
parent fa1e181f4c
commit b5dfc04040
Signed by: daylin
GPG key ID: C1E52E7DD81DF79F

View file

@ -12,19 +12,8 @@ A web UI is available at [nimble.directory](https://nimble.directory)([repo](htt
But, there are some outstanding [issues](https://github.com/FedericoCeratto/nim-package-directory/issues/53) that have affected even my own packages. But, there are some outstanding [issues](https://github.com/FedericoCeratto/nim-package-directory/issues/53) that have affected even my own packages.
This site is client-only, powered by [karax](https://github.com/karaxnim/karax) and styled with [unocss](https://github.com/unocss/unocss). This site is client-only, powered by [karax](https://github.com/karaxnim/karax) and styled with [unocss](https://github.com/unocss/unocss).
It provide a single page search UI over `nim-lang/packages`.
This makes it trivial to deploy with Github Actions. This makes it trivial to deploy with Github Actions.
## usage
On page load 10 random packages and a set of tags will be selected.
Search can be modified by specifying fields.
examples:
- `tag:database sqlite`
- `license:MIT web`
## license ## license
Logos in [site/img](./site/img/) by [The Nim Programming language](https://nim-lang.org) used under [CC BY 3.0](https://github.com/nim-lang/website/blob/master/LICENSE.md). Logos in [site/img](./site/img/) by [The Nim Programming language](https://nim-lang.org) used under [CC BY 3.0](https://github.com/nim-lang/website/blob/master/LICENSE.md).