Skip to content

Commit f7cca48

Browse files
committed
Update readme
1 parent 8034e68 commit f7cca48

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,17 @@ The core objects and interfaces of the [IPFS](https://github.com/ipfs/ipfs) (Int
66

77
The interplanetary file system is the permanent web. It is a new hypermedia distribution protocol, addressed by content and identities. IPFS enables the creation of completely distributed applications. It aims to make the web faster, safer, and more open.
88

9-
It supports .NET Standard 2.0.
9+
This library supports .NET Standard 2.0.
1010

11-
### 🚧 NOTICE 🚧
12-
We've only [just](https://github.com/richardschneider/net-ipfs-http-client/issues/72) moved into the shipyard, reviving a project that has been abandoned since 2019.
11+
## Install
1312

14-
**We're actively working to make it usable again.**
13+
Published releases are available on [NuGet](https://www.nuget.org/packages/IpfsShipyard.Ipfs.Core). To install, run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console).
14+
15+
PM> Install-Package IpfsShipyard.Ipfs.Core
16+
17+
Or using [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet)
18+
19+
> dotnet add package IpfsShipyard.Ipfs.Core
1520

1621
## Major objects
1722

@@ -38,22 +43,12 @@ The [DagNode](https://richardschneider.github.io/net-ipfs-core/api/Ipfs.DagNode.
3843
the objects themselves, and that every object contains a secure
3944
representation of its children.
4045

41-
Every Merkle is a directed acyclic graph (DAG) because each node is accessed via its name (the hash of `DagNode`). Each branch of Merkle is the hash of its local content (data and links); naming children by their hash instead of their full contents. So after creation there is no way to edit a DagNode. This prevents cycles (assuming there are no hash collisions) since one can not link the first created node to the last note to create the last reference.
42-
43-
## Base58
44-
45-
Most binary data (objects) in IPFS is represented as a [Base-58](https://en.wikipedia.org/wiki/Base58) string; the BitCoin alphabet is used.
46-
47-
> Base58 is a group of binary-to-text encoding schemes used to represent large integers as alphanumeric text. It is similar to Base64 but has been modified to avoid both non-alphanumeric characters and letters which might look ambiguous when printed. It is therefore designed for human users who manually enter the data, copying from some visual source, but also allows easy copy and paste because a double-click will usually select the whole string.
46+
Every Merkle is a directed acyclic graph (DAG) because each node is accessed via its name (the hash of `DagNode`). Each branch of Merkle is the hash of its local content (data and links); naming children by their hash instead of their full contents. So after creation there is no way to edit a DagNode. This prevents cycles (assuming there are no hash collisions) since one can not link the first created node to the last note to create the last reference.
4847

4948
## Related Projects
5049

51-
- [IPFS DSL](https://github.com/cloveekprojeqt/ipfs-dsl) - A declarative embedded language for building compositional programs and protocols over the InterPlanetary File System.
5250
- [IPFS HTTP Client](https://github.com/ipfs-shipyard/net-ipfs-http-client) - A .Net client library for the IPFS HTTP API.
53-
- [IPFS HTTP Gateway](https://github.com/richardschneider/net-ipfs-http-gateway) - Serves IPFS files/directories via HTTP.
54-
- [IPFS Engine](https://github.com/richardschneider/net-ipfs-engine) - Implements the Core API.
55-
- [Peer Talk](https://github.com/richardschneider/peer-talk) - Peer to peer communication.
5651

5752
## License
58-
The IPFS Core library is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php "Read more about the MIT license form") license. Refer to the [LICENSE](https://github.com/richardschneider/net-ipfs-core/blob/master/LICENSE) file for more information.
53+
The IPFS Core library is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php "Read more about the MIT license form") license. Refer to the [LICENSE](LICENSE) file for more information.
5954

0 commit comments

Comments
 (0)