Updated README with more details about the repository

This commit is contained in:
aewens 2020-12-21 03:23:41 +00:00
parent 5155d79268
commit cc468405b3

README.md Normal file → Executable file
View File

@ -1,6 +1,48 @@
# Specifications
All specifications will be finalized using the format outlined by the Tildeverse's RFCs outlined in their [RFC 0](https://rfc.tildeverse.org/rfcs/0). This is partially to take away the need for me to make my own format and also due to necessity in case I submit any of these to the Tildever'se RFC repository later on. For pragmatic reasons, all drafts will not hold this standard so that I can focus more writing out the concepts for each draft rather than abiding to any standard.
As specified above, there will be two types of specifications here: drafts and proposals. The life cycle being that an idea will begin as a draft, and if it survives long enough to further attention it will be finalized as a proposal. Should there be any interest in any of those proposals they will be submitted as an RFC to the [Tildeverse RFC](https://rfc.tildeverse.org) community for approval.
## Feedback
I write these specifications partially to crystallize ideas in my head into concrete concepts that I can refer back to later, but also as a means for others to provide feedback and help in creating a more robust final product. I understand I will not always arrive to the best solution for the problems these specifications aim to solve, so I am very open to any comments or ideas on how these specifications can be improved. So if you read any of these and feel the need to comment or contribute, please do so by [opening an issue](https://tildegit.org/aewens/specs/issues/new) on this repository and drafting your initial feedback. This will also work as the same medium for any further discussions on said comments. You can also, if so inclined, provide feedback in the form of a [pull request](https://tildegit.org/aewens/specs/pulls) for making direct changes to one or more specifications (especially if the feedback is just about various typos).
If, for whatever reason, you want to provide feedback in a more private manner you can also reach out to me on the [IRC network](https://tilde.chat) via a private message, where I go by the same username "aewens" or through my tilde email of the same username at the domain ttm.sh (the fancy alias used by [tilde.team](https://tilde.team)).
## Topics
### Distributed Network
Some of these specifications will be written to serve the purpose of facilitating a distributed network of services. The end goal being a network that any network can join (behind a firewall or otherwise) and participate in that requires no centralized server to keep it running. The specifications will serve as the blueprints for creating such a network or contributing to the development of an existing one.
## Table of Contents
1. Drafts
1. [0001] Standards 1: Distributed Data Schematics
1. [0002] Standards 2: Distributed Routing System
1. [0003] Standards 3: Distributed Routing Wire Protocol
1. [0004] Standards 4: Distributed Authentication System
1. Proposals
## Queued
Everything that has not yet been written:
- 0002
- 0003
- 0004
## Pending
What is currently being written:
- 0001
## Copyright
All works are licensed under the [CC BY-NC-SA 4.0 License](LICENSE.txt).
[0001]: drafts/0001-standards-schemas.md
[0002]: drafts/0002-routing-system.md
[0003]: drafts/0003-wire-protocol.md
[0004]: drafts/0004-auth-system.md