Skip to content

Commit 737ac26

Browse files
aaraniknocte
authored andcommitted
README: create README file
This commit also updates the LICENSE file.
1 parent 25002c6 commit 737ac26

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

LICENSE

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
MIT License
22

3-
Copyright (c) 2021 Afshin Arani
3+
Copyright (c) 2021-2023 Afshin Arani
4+
Copyright (c) 2021-2023 NodeEffect Ltd (nodeffect.com)
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy
67
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
NOnion
2+
-------------------------------
3+
[![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)
4+
5+
_Unofficial_ work in progress .NET TOR client library (implemented in F#)
6+
7+
- [How do I add this to my project?](#how-do-i-add-this-to-my-project)
8+
- [Contributing](#contributing)
9+
- [Contributors](https://github.com/nblockchain/NOnion/graphs/contributors)
10+
- [License](https://github.com/nblockchain/NOnion/blob/master/LICENSE)
11+
12+
# How do I add this to my project?
13+
14+
Install via NuGet:
15+
16+
## .NET CLI
17+
```
18+
> dotnet add package NOnion
19+
```
20+
21+
## VS Package Manager
22+
```
23+
> Install-Package NOnion
24+
```
25+
26+
# Contributing
27+
28+
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 commit comments

Comments
 (0)