fix commitlint and create README file #57
Conversation
README.md
Outdated
| ------------------------------- | ||
| [](https://github.com/nblockchain/NOnion/actions/workflows/CI.yml) | ||
|
|
||
| _Unofficial_ work in progress TOR client library implemented in F# |
There was a problem hiding this comment.
I would say dotnet TOR-client library (implemented in F#), otherwise C# devs might think it's only consumable from F#
README.md
Outdated
| Install via NuGet | ||
|
|
||
| ``` | ||
| > Install-Package NOnion |
There was a problem hiding this comment.
please note, this is not a command that works in any terminal, let's add more specific instructions here
README.md
Outdated
| * [Afshin Arani](https://github.com/aarani) | ||
| * [knocte](https://github.com/knocte) | ||
| * [Parham Saremi](https://github.com/parhamsaremi) | ||
| * [webwarrior-ws](https://github.com/webwarrior-ws) |
There was a problem hiding this comment.
this list might get outdated easily, how about adding a link to https://github.com/nblockchain/NOnion/graphs/contributors instead?
README.md
Outdated
|
|
||
| # License | ||
|
|
||
| MIT License |
There was a problem hiding this comment.
DRY, let's simply add a link to the License file
|
Last thing, maybe bring the |
This commit also updates the LICENSE file.
Done |
aarani
changed the title
aarani
changed the title
It's time we add a good README, I keep blanking on how to make the documentation
It's too hard to do a simple connection to TOR (directory bootstrap, connect guard, create a circuit, open stream)
#56 is a small change in the path to making using NOnion easier either we merge README without documentation
or we DRAFT this and wait until I make some high-level APIs for easier usage.
Ah I also updated the year in LICENSE, it wasn't touched in 2 years.