-
Notifications
You must be signed in to change notification settings - Fork 19
README_template
| Title | Title goes here |
|---|---|
| Version | Version goes here |
description of the project. (less than 50 word)
if any, must be listed and a link to their projects should be present.
- Motivation for this project
- A longer justification of the project.
- This may be a couple of hundred words.
- You can talk about the current situation and how this project would help get a better result.
Refer the link to get an idea. You can just use a one word to show the status of the project, like - incubation. See lifecycle documentation
Solution to the problem addressed in the motivation section. Try to make this as detailed as possible. The topics given below are just suggestions, address only if they are relevant to your problem:
-
Transactions - including types, confidentiality, signing, traceability, identity of participants, contracts (scripts)
-
Effects on User facing Clients that help with transaction formation (similar to Wallets in BTC)
-
Effects on the network, throughput, visibility to other participants, change in protocol if any, criteria for network participation
-
Block formation and ledger formation: Consensus algorithm, size overhead, effects on the throughput and rate
-
Backward compatibility (hard fork or updates by all network participants needed?)
-
Rough design and scenarios on the probable effects, if any
-
The use of diagrams is encouraged to elucidate concepts
-
Address any possible objections and also support that came up during seed proposal from technical community on the lists.
-
Traceability, testing criteria to gauge effects on installed base.
-
License of code base (including dependencies)
-
Any trademarks used in the project name or codebase
Here goes your github ids
How to host and test the project. How to deploy and use. How does one know that it works.
References used. Links to them.