Adding license file

christroutner · Aug 22, 2022 · 58d16b3 · 58d16b3
1 parent f5f68c3
commit 58d16b3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,7 @@
+Copyright 2022 Permissionless Software Foundation contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -2,4 +2,10 @@
 
 This is a Docker container that wraps go-ipfs/kubo in the [Trickle](https://wiki.archlinux.org/title/trickle) Linux command line app, so that bandwidth consumption can be controlled by the adminstrator.
 
-A quick search for 'bandwidth ipfs' will reveal a lot of frustrated stories of people wanting to use go-ipfs but not being able to control the amount of bandwidth that it uses. This Docker container solve that problem. Bandwidth shaping is controlled by Trickle, which wraps the go-ipfs binary.
+A quick search for 'bandwidth ipfs' will reveal a lot of frustrated stories of people wanting to use go-ipfs but not being able to control the amount of bandwidth that it uses. This Docker container solves that problem. Bandwidth shaping is controlled by Trickle, which wraps the go-ipfs binary.
+
+This Docker image is expected to be used with Docker Compose to configure it. Study the [docker-compose.yml](./docker-compose.yml) file to learn how to set up the container for your own usage. Envrionment variables are used to pass startup arguments to the IPFS daemon, and also to configure the bandwidth rate limits.
+
+## License
+
+[MIT](LICENSE.md)