diff --git a/LICENSE b/LICENSE index ee2accb..b6a8537 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,8 @@ MIT License -Copyright (c) 2017 Agorise, IBC. +Copyright (c) 2017 AGORISE, LTD. +An International Business Company, Cyprus Reg# ΗΕ375959 + Contains works from BitShares Munich IVS Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/README.md b/README.md index 3fb68b2..be38e06 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ # C-IPFS -IPFS implementation in C, (not just an API client library).
-
-getting started: https://github.com/ipfs/specs/blob/master/overviews/implement-ipfs.md
-specifications: https://github.com/ipfs/specs
-getting started: https://github.com/ipfs/community/issues/177
-libp2p: https://github.com/libp2p/specs
-
-Prerequisites: To compile the C version you will need:
-lmdb https://github.com/jmjatlanta/lmdb
-c-protobuf https://github.com/Agorise/c-protobuf
-c-multihash https://github.com/Agorise/c-multihash
-c-multiaddr https://github.com/Agorise/c-multiaddr
-c-libp2p https://github.com/Agorise/c-libp2p
-
-And of course this project at https://github.com/Agorise/c-ipfs
-
+IPFS implementation in C, (not just an API client library). + +## Quick start for users: +* **ipfs init** to create an ipfs repository on your machine +* **ipfs add MyFile.txt** to add a file to the repository, will return with a hash that can be used to retrieve the file. +* **ipfs cat _hash_** to retrieve a file from the repository + +## For techies (ipfs spec docs): +* [getting started](https://github.com/ipfs/specs/blob/master/overviews/implement-ipfs.md) +* [specifications](https://github.com/ipfs/specs) +* [getting started](https://github.com/ipfs/community/issues/177) +* [libp2p](https://github.com/libp2p/specs) + +## Prerequisites: To compile the C version you will need: +* [lmdb](https://github.com/jmjatlanta/lmdb) +* [c-protobuf](https://github.com/Agorise/c-protobuf) +* [c-multihash](https://github.com/Agorise/c-multihash) +* [c-multiaddr](https://github.com/Agorise/c-multiaddr) +* [c-libp2p](https://github.com/Agorise/c-libp2p) + +And of course this project at https://github.com/Agorise/c-ipfs + The compilation at this point is simple, but not very flexible. Place all of these projects in a directory. Compile all (the order above is recommended) by going into each one and running "make all".