From 0d598ec58ed741f443739591074c73fc8fc6b01f Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 10 Sep 2024 17:51:11 -0400 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d69926e..fe79c7f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# codex-spec -Specs for Codex network +## Codex Specifications + +Codex is building a decentralized durability engine aiming to allow users to have data persistence. +This repository contains Codex specifications currently under discussion. + +Visit the official [Codex website]() for more information about the project. + +Note: Codex is still under active development. +Specifications located in this repository should be considered not production ready. +Discussion is conducted with the intention of maturing each specification. + +## Contributors + +Contributors are welcomed to create a new pull request with specifications. +It is reccommened to adhere to the 1/COSS guidelines when writing specifications. + +Please adhere to the following guidelines: + +- Name and title of all specification must have the `CODEX-` prefix +- Use [semantic breaks](https://sembr.org/) +- It is reccomended to base specification on the Vac [template](./template.md) + +## License