Update README.md

This commit is contained in:
Jimmy Debe 2024-09-12 23:48:20 -04:00 committed by GitHub
parent ce9651d606
commit 1447bc35cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -3,21 +3,24 @@
Codex is building a decentralized durability engine aiming to allow users to have data persistence. Codex is building a decentralized durability engine aiming to allow users to have data persistence.
This repository contains Codex specifications currently under discussion. This repository contains Codex specifications currently under discussion.
Visit the official [Codex website]() for more information about the project. Visit the official [Codex website](https://codex.storage/) for more information about the project.
Note: Codex is still under active development. Note: Codex is still under active development.
Specifications located in this repository should be considered not production ready. Specifications located in this repository should be considered not production-ready.
Discussion is conducted with the intention of maturing each specification. Discussion is held with the intention of maturing each specification.
## Contributors ## Contributing
Contributors are welcomed to create a new pull request with specifications. Contributors are welcome to create a new pull request to discuss a topic related to the Codex protocol.
It is reccommened to adhere to the 1/COSS guidelines when writing specifications. When writing specifications,
it is recommended to adhere to the [1/COSS](https://github.com/vacp2p/rfc-index/blob/main/vac/1/coss.md) guidelines.
Please adhere to the following guidelines: Please adhere to the following guidelines:
- Name and title of all specification must have the `CODEX-` prefix - Name and title of all specifications must have the `CODEX-` prefix
- Use [semantic breaks](https://sembr.org/) - Try to use [semantic breaks](https://sembr.org/)
- It is reccomended to base specification on the Vac [template](./template.md) - Use the [template](./template.md) to help construct specifications
## License ## License
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).