🐺 foss-template

Template for creating new open source repositories that follow the N3N open source guidelines.

TEMPLATE INSTRUCTIONS

1. Create a new repository under N3NX using this template.
2. Metadata: This README file contains tags metadata for indexing. Before starting any project, edit this readme and only modify the values present in project_tags and project_featured fields according to the working project.
3. Title: Change the first line of this README to the name of your project, and replace the wolf with an emoji that represents your project. 🚨 Your emoji selection is critical.
4. Badges: In the badges section above, change the repo name in each URL. If you are creating something other than a Rust crate, remove the crates.io and docs badges (and feel free to add more appropriate ones for your language).
5. CI: In ./github/workflows/ rename rust-ci.yml (or the appropriate config for your language) to ci.yml. And go over it and adapt it to work for your project
6. Cleanup: Remove this section of the README and any unused files (such as configs for other languages) from the repo.

Contribution

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started. Please also read our Contributor Terms before you make any contributions.

Any contribution intentionally submitted for inclusion in a N3N project or a Knytx Labs project, shall comply with the Rust standard licensing model (MIT OR Apache 2.0) and therefore be dual licensed as described below, without any additional terms or conditions:

License

This contribution is dual licensed under EITHER OF

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

For clarity, "your" refers to the N3N contributors, NCRYPTO Labs Private Limited or any other licensee/user of the contribution.