Standardized Readme
See https://github.com/ipfs/community/issues/124 License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Jun 21, 2016 at 13:14 UTC
eb955dff71ba9388bdbf01638d27847f0498bac0
2 files changed
+31
-14
LICENSE
+1
-1
@@ -1,6 +1,6 @@
1
The MIT License (MIT)
2
3
-Copyright (c) 2014 Juan Batiz-Benet
3
+Copyright (c) 2016 Juan Batiz-Benet
4
5
Permission is hereby granted, free of charge, to any person obtaining a copy
6
of this software and associated documentation files (the "Software"), to deal
README.md
+30
-13
@@ -1,7 +1,15 @@
1
-
1
+# go-ipfs
2
3
-# IPFS implementation in Go
4
-[](https://godoc.org/github.com/ipfs/go-ipfs) [](https://travis-ci.org/ipfs/go-ipfs)
3
+
4
+
5
+[](http://ipn.io)
6
+[](http://ipfs.io/)
7
+[](http://webchat.freenode.net/?channels=%23ipfs)
8
+[](https://github.com/RichardLitt/standard-readme)
9
+[](https://godoc.org/github.com/ipfs/go-ipfs)
10
+[](https://travis-ci.org/ipfs/go-ipfs)
11
+
12
+> IPFS implementation in Go
13
14
IPFS is a global, versioned, peer-to-peer filesystem. It combines good ideas from
15
Git, BitTorrent, Kademlia, SFS, and the Web. It is like a single bittorrent swarm,
@@ -12,7 +20,7 @@ For more info see: https://github.com/ipfs/ipfs.
20
21
Please put all issues regarding IPFS _design_ in the
22
[ipfs repo issues](https://github.com/ipfs/ipfs/issues).
15
-Please put all issues regarding Go IPFS _implementation_ in [this repo](https://github.com/ipfs/go-ipfs/issues).
23
+Please put all issues regarding the Go IPFS _implementation_ in [this repo](https://github.com/ipfs/go-ipfs/issues).
24
25
## Table of Contents
26
@@ -20,18 +28,20 @@ Please put all issues regarding Go IPFS _implementation_ in [this repo](https://
28
- [Install](#install)
29
- [Install prebuilt packages](#install-prebuilt-packages)
30
- [Build from Source](#build-from-source)
23
- - [Prerequisite: Install Go](#prerequisite-install-go)
24
- - [Download + Compile IPFS](#download--compile-ipfs)
31
+ - [Install Go](#install-go)
32
+ - [Download and Compile IPFS](#download-and-compile-ipfs)
33
+ - [Troubleshooting](#troubleshooting)
34
- [Development Dependencies](#development-dependencies)
26
-- [Updating](#updating)
35
+ - [Updating](#updating)
36
- [Usage](#usage)
37
- [Getting Started](#getting-started)
38
- [Some things to try](#some-things-to-try)
39
- [Docker usage](#docker-usage)
40
- [Docker usage with VirtualBox/boot2docker (OSX and Windows)](#docker-usage-with-virtualboxboot2docker-osx-and-windows)
32
-- [Troubleshooting](#troubleshooting)
33
-- [Contributing](#contributing)
41
+ - [Troubleshooting](#troubleshooting-1)
42
- [Todo](#todo)
43
+- [Contributing](#contributing)
44
+ - [Want to hack on IPFS?](#want-to-hack-on-ipfs)
45
- [License](#license)
46
47
## Security Issues
@@ -71,7 +81,7 @@ export PATH=$PATH:$GOPATH/bin
81
82
(If you run into trouble, see the [Go install instructions](https://golang.org/doc/install)).
83
74
-#### Download + Compile IPFS
84
+#### Download and Compile IPFS
85
86
go-ipfs differs from the vanilla `go get` flow: it uses
87
[gx](https://github.com/whyrusleeping/gx)/[gx-go](https://github.com/whyrusleeping/gx-go)
@@ -110,7 +120,8 @@ dependencies as well.
120
121
If you make changes to the protocol buffers, you will need to install the [protoc compiler](https://github.com/google/protobuf).
122
113
-## Updating
123
+### Updating
124
+
125
IPFS has an updating tool that can be accessed through `ipfs update`. The tool is
126
not installed alongside IPFS in order to keep that logic independent of the main
127
codebase. To install `ipfs update`, either [download it here](https://gobuilder.me/github.com/ipfs/ipfs-update)
@@ -255,13 +266,19 @@ For any other problems, check the [issues list](https://github.com/ipfs/go-ipfs/
266
and if you dont see your problem there, either come talk to us on irc (freenode #ipfs) or
267
file an issue of your own!
268
269
+## Todo
270
+
271
+An IPFS alpha version has been released in February 2015. Things left to be done are all marked as [issues](https://github.com/ipfs/go-ipfs/issues).
272
+
273
## Contributing
274
275
Please see [Contribute.md](contribute.md)!
276
262
-## Todo
277
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
278
264
-An IPFS alpha version has been released in February 2015. Things left to be done are all marked as [issues](https://github.com/ipfs/go-ipfs/issues).
279
+### Want to hack on IPFS?
280
+
281
+[](https://github.com/ipfs/community/blob/master/contributing.md)
282
283
## License
284