Add README to docs folder, fixes #5049
Also adds a link to the authors list in the top-level README. License: MIT Signed-off-by: Rob Brackett <rob@robbrackett.com>
Rob Brackett committed
Jun 7, 2018 at 09:48 UTC
76f018cacf112a0b131a61ad902807d6e3e4788f
2 files changed
+39
-1
README.md
+1
-1
@@ -322,7 +322,7 @@ file an issue of your own!
322
323
## Contributing
324
325
-Please see [Contribute.md](contribute.md)!
325
+We ❤️ all [our contributors](docs/AUTHORS); this project wouldn’t be what it is without you! If you want to help out, please see [Contribute.md](contribute.md).
326
327
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
328
docs/README.md
new
+38
@@ -0,0 +1,38 @@
1
+# Documentation and Guides
2
+
3
+If you’re experiencing an issue with IPFS, **please follow [our issue guide](github-issue-guide.md) when filing an issue!**
4
+
5
+Otherwise, check out the following guides to using and developing IPFS:
6
+
7
+
8
+## General Usage
9
+
10
+- [Transferring a File Over IPFS](file-transfer.md)
11
+- [Configuration reference](config.md)
12
+ - [Datastore configuration](datastores.md)
13
+ - [Experimental features](experimental-features.md)
14
+- [Installing command completion](command-completion.md)
15
+- [Mounting IPFS with FUSE](fuse.md)
16
+- [Installing plugins](plugins.md)
17
+
18
+
19
+## API Support
20
+
21
+- [How to Implement an API Client](implement-api-bindings.md)
22
+- [Connecting with Websockets](transports.md) — if you want `js-ipfs` nodes in web browsers to connect to your `go-ipfs` node, you will need to turn on websocket support in your `go-ipfs` node.
23
+
24
+
25
+## Developing `go-ipfs`
26
+
27
+- Building on…
28
+ - [Windows](windows.md)
29
+ - [OpenBSD](openbsd.md)
30
+- [Performance Debugging Guidelines](debug-guide.md)
31
+- [Release Checklist](releases.md)
32
+
33
+
34
+## Other
35
+
36
+- [Thanks to all our contributors ❤️](AUTHORS) (We use the `generate-authors.sh` script to regenerate this list.)
37
+- Our [Developer Certificate of Origin (DCO)](developer-certificate-of-origin) — when you sign your commits with `Signed-off-by: <your name>`, you are agreeing to this document.
38
+- [How to file a GitHub Issue](github-issue-guide.md)