Cleaning up README and moving documentation to docs #12
Conversation
There was a problem hiding this comment.
ACK a3e5477
The idea looks good. Maybe we can have a more clear name for the how_to doc?
| Check [Developer Resources](docs/developer_resources.md) on information on the protocol and further reading. | ||
|
|
There was a problem hiding this comment.
Can we add build and test instructions here too? Just two lines of build the binary with cargo build, and run all the tests with cargo test. Its trivial, but just not written anywhere.
There was a problem hiding this comment.
Yep, added an "Install/Build from Source" section in the README and removed it from app_instructions
README.md
Outdated
| - [Protocol between takers and makers](#protocol-between-takers-and-makers) | ||
| - [Code Structure](#code-structure) | ||
| - [Further reading](#further-reading) | ||
| - [Docs](#docs) | ||
| - [Chris Belcher's personal roadmap for the project](#chris-belchers-personal-roadmap-for-the-project) | ||
| - [Community](#community) | ||
|
|
||
| ## State of the project | ||
|
|
||
| The project is nearly usable, though it doesnt have all the necessary features yet. The code written so far is published for developers and power users to play around with. It doesn't have config files yet so you have to edit the source files to configure stuff. It is possible to run it on mainnet, but only the brave will attempt that, and only with small amounts. |
There was a problem hiding this comment.
Maybe we can add some further information on what this library is currently. Along the line of, it's a cli app written in rust as demo prototype of working with underlying coinswap subroutines and primitives.
docs/how_to.md
Outdated
| @@ -0,0 +1,169 @@ | |||
| # Documentation on Creating Coinswap | |||
There was a problem hiding this comment.
Maybe we can call this an "Example Coinswap with teleport cli app".
We might not have this binary later. We will make sure to update this example accordingly.
changed it to |
House cleaning for README and initiating structured docs.
TO DO: