Edit README, create assets folder

storj · Oct 30, 2018 · cfa3298 · cfa3298
1 parent 3afce5c
commit cfa3298
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
-# docs
-Tutorials and documentation for the Storj V3 Network
+# Docs
+
+> Tutorials and documentation for the Storj V3 Network
+
+![logo](assets/logo.png)
+
+This repository holds some basic tutorials for working with the Storj v3 architecture:
+
+- [Learn how to run the Captain Planet test network](test-network.md)
+- [Use the Storj Uplink CLI tool to manipulate files](uplink-cli.md)
+- [Use the Gateway to mimic AWS s3 filestores](s3-gateway.md)
+
+Have fun!
+
+## Contributing
+
+We'd love to have any contributions back. Feel that these tutorials could be improved? Open an issue, or file a PR! We'll take a look.
+
+Want to talk about how to make these methods work further? Need more help, or wonder if there is something we've missed? Check out the [Rocketchat](https://community.storj.io) - head to the `#dev` channel to talk to our devs about Storj. Or, look at the source code for all of the content mentioned here over on [storj/storj](https://github.com/storj/storj)
+
+## License
+
+Apache 2.0 © Storj Labs Inc.
diff --git a/components.png → assets/components.png b/components.png → assets/components.png
diff --git a/assets/logo.png b/assets/logo.png