From 39bf6f2d05408a65e9d1774888e768eb9058d21e Mon Sep 17 00:00:00 2001 From: Daylin Morgan Date: Mon, 13 Nov 2023 23:26:28 -0600 Subject: [PATCH] docs: add license and README --- LICENSE | 22 ++++++++++++++++++++++ README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..429d853 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2023 Daylin Morgan + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md index 18807e2..3f7192f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ # nimpkgs +The [nimble.directory](https://nimble.directory) alternative no one asked for, that I felt like making anyways. +Check it out at [nimpkgs.dayl.in](https://nimpkgs.dayl.in). + +
+ +## why though... + +In it's [current form](nim-lang/packages) packages for `nim` are managed by a single JSON file. +A web UI is available at [nimble.directory](https://nimble.directory)([repo](https://github.com/FedericoCeratto/nim-package-directory)). +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). +It provide a single page search UI over `nim-lang/packages`. +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 + +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). +