Skip to content

Commit

Permalink
README: create README file
Browse files Browse the repository at this point in the history
This commit also updates the LICENSE file.
  • Loading branch information
aarani authored and knocte committed Apr 11, 2023
1 parent 25002c6 commit 737ac26
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2021 Afshin Arani
Copyright (c) 2021-2023 Afshin Arani
Copyright (c) 2021-2023 NodeEffect Ltd (nodeffect.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
NOnion
-------------------------------
[![Build Status](https://github.com/nblockchain/NOnion/actions/workflows/CI.yml/badge.svg?branch=master&event=push)](https://github.com/nblockchain/NOnion/actions/workflows/CI.yml)

_Unofficial_ work in progress .NET TOR client library (implemented in F#)

- [How do I add this to my project?](#how-do-i-add-this-to-my-project)
- [Contributing](#contributing)
- [Contributors](https://github.com/nblockchain/NOnion/graphs/contributors)
- [License](https://github.com/nblockchain/NOnion/blob/master/LICENSE)

# How do I add this to my project?

Install via NuGet:

## .NET CLI
```
> dotnet add package NOnion
```

## VS Package Manager
```
> Install-Package NOnion
```

# Contributing

Don't underestimate the power of your contribution - even a small pull request can make a big difference in a small project, so submit yours today!

0 comments on commit 737ac26

Please sign in to comment.