work on readme
Jeromy committed
Nov 8, 2014 at 21:09 UTC
a565587fdcd2013d58a6a93cd6b0a84fad0b2e60
1 file changed
+26
-5
README.md
+26
-5
@@ -1,6 +1,12 @@
1
-# ipfs implementation in go. [](https://godoc.org/github.com/jbenet/go-ipfs) [](https://travis-ci.org/jbenet/go-ipfs)
1
+# ipfs implementation in go.
2
+[](https://godoc.org/github.com/jbenet/go-ipfs) [](https://travis-ci.org/jbenet/go-ipfs)
3
3
-See: https://github.com/jbenet/ipfs
4
+Ipfs is a global, versioned, peer-to-peer filesystem. It combines good ideas from
5
+Git, BitTorrent, Kademlia, SFS, and the Web. It is like a single bittorrent swarm,
6
+exchanging git objects. IPFS provides an interface as simple as the HTTP web, but
7
+with permanence built in. You can also mount the world at /ipfs.
8
+
9
+For more info see: https://github.com/jbenet/ipfs
10
11
Please put all issues regarding IPFS _design_ in the
12
[ipfs repo issues](https://github.com/jbenet/ipfs/issues).
@@ -18,13 +24,13 @@ go install
24
25
NOTES:
26
21
-* `git` and mercurial (`hg`) are required in order for `go get` to fetch
27
+* `git` is required in order for `go get` to fetch
28
all dependencies.
29
* Package managers often contain out-of-date `golang` packages.
30
Compilation from source is recommended.
31
* If you are interested in development, please install the development
32
dependencies as well.
27
-* **WARNING: older versions of OSX FUSE (for Mac OS X) can cause kernel panics when mounting!**
33
+* *WARNING: older versions of OSX FUSE (for Mac OS X) can cause kernel panics when mounting!*
34
We strongly recommend you use the [latest version of OSX FUSE](http://osxfuse.github.io/).
35
(See https://github.com/jbenet/go-ipfs/issues/177)
36
@@ -70,13 +76,28 @@ system, this is done with `ipfs init`. See `ipfs help init` for information on
76
the optional arguments it takes. After initialization is complete, you can use
77
`ipfs mount`, `ipfs add` and any of the other commands to explore!
78
79
+### Some things to try
80
+
81
+Basic proof of 'ipfs working' locally:
82
+
83
+ echo "hello world" > hello
84
+ ipfs add hello
85
+ # This should output a hash string that looks something like:
86
+ # QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
87
+ ipfs cat <that hash>
88
74
-NOTE: if you have previously installed ipfs before and you are running into
89
+
90
+### Troubleshooting
91
+If you have previously installed ipfs before and you are running into
92
problems getting a newer version to work, try deleting (or backing up somewhere
93
else) your config directory (~/.go-ipfs by default) and rerunning `ipfs init`.
94
This will reinitialize the config file to its defaults and clear out the local
95
datastore of any bad entries.
96
97
+For any other problems, check the [issues list](http://github.com/jbenet/go-ipfs/issues)
98
+and if you dont see your problem there, either come talk to us on irc (freenode #ipfs) or
99
+file an issue of your own!
100
+
101
102
## Contributing
103