logos-messaging/packages
1
0
Fork 0
mirror of https://github.com/logos-messaging/packages.git synced 2026-01-04 07:03:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'patch-6' of https://github.com/FedericoCeratto/packages into FedericoCeratto-patch-6

Browse Source
This commit is contained in:
Dominik Picheta 2018-02-19 20:57:09 +00:00
commit 5732109799
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -7,6 +7,8 @@ This is a central listing of all packages for
An overview of all Nimble packages is available in the An overview of all Nimble packages is available in the
[library documentation](https://nim-lang.org/docs/lib.html#nimble). [library documentation](https://nim-lang.org/docs/lib.html#nimble).
NOTE: The packages listed here are not peer-reviewed or otherwise screened. We try to keep the list up-to-date but we cannot guarantee quality or maturity of the packages.
## Adding your own package ## Adding your own package
To add your own package, fork this repository, edit To add your own package, fork this repository, edit
[packages.json](packages.json) and make a pull request. [packages.json](packages.json) and make a pull request.
@ -23,14 +25,29 @@ optional):
* tags - A list of tags describing this package. * tags - A list of tags describing this package.
* description - A description of this package. * description - A description of this package.
* license - The license of the source code in the package. * license - The license of the source code in the package.
* web - An optional url for humans to read additional information about * web - An optional URL for humans to read additional information about
the package. the package.
* doc - An optional URL for humans to read the package HTML documentation
### Requirements
While we really appreciate your contribution, please follow the requirements: other developers will rely on your package. Non-compliant packages might be removed with no warning.
* The URL should work, a .nimble file should be present and the package should be installable
* The package should build correctly with the latest Nim release
* The package should not contain files without a license or in breach of 3rd parties licensing
* Non-mature packages should be flagged as such, especially if they perform security-critical tasks (e.g. encryption)
* If abandoning a package, please tag it as "abandoned"
* Optionally GPG-sign your releases
* Optionally follow [SemVer](http://semver.org)
Your packages may be removed if the url stops working. It goes without saying Your packages may be removed if the url stops working. It goes without saying
that your pull request will not be accepted unless you fill out all of the that your pull request will not be accepted unless you fill out all of the
above required fields correctly, the package that ``url`` points to must also above required fields correctly, the package that ``url`` points to must also
contain a .nimble file, or else it will be rejected. contain a .nimble file, or else it will be rejected.
The requirements might change in future.
## Renaming packages ## Renaming packages
To rename a package you will need to add a new entry for your package. Simply To rename a package you will need to add a new entry for your package. Simply
@ -56,4 +73,5 @@ For example:
... ...
}, },
... ...
``` ```