Forked from PurpleBooth/Template-README-for-containers.md
Created
March 29, 2016 12:24
Revisions
-
PurpleBooth revised this gist
Sep 11, 2015 . 1 changed file with 5 additions and 0 deletions.There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -59,6 +59,11 @@ docker run give.example.org/of/your/container:v0.2.1 bash * And the version numbers v2.0.0 * That are in this container v0.3.2 ## Find Us * [GitHub](https://github.com/your/repository) * [Quay.io](https://quay.io/repository/your/docker-repository) ## Contributing Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. -
PurpleBooth revised this gist
Sep 11, 2015 . 1 changed file with 0 additions and 1 deletion.There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -41,7 +41,6 @@ docker run give.example.org/of/your/container:v0.2.1 bash * `VARIABLE_ONE` - A Description * `ANOTHER_VAR` - More Description * `YOU_GET_THE_IDEA` - And another #### Volumes -
PurpleBooth created this gist
Sep 11, 2015 .There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -0,0 +1,86 @@ # Docker Container Name A one paragraph description about the container. ## Getting Started These instructions will cover usage information and for the docker container ### Prerequisities In order to run this container you'll need docker installed. * [Windows](https://docs.docker.com/windows/started) * [OS X](https://docs.docker.com/mac/started/) * [Linux](https://docs.docker.com/linux/started/) ### Usage #### Container Parameters List the different parameters available to your container ```shell docker run give.example.org/of/your/container:v0.2.1 parameters ``` One example per permutation ```shell docker run give.example.org/of/your/container:v0.2.1 ``` Show how to get a shell started in your container too ```shell docker run give.example.org/of/your/container:v0.2.1 bash ``` #### Environment Variables * `VARIABLE_ONE` - A Description * `ANOTHER_VAR` - More Description there * `YOU_GET_THE_IDEA` - And another #### Volumes * `/your/file/location` - File location #### Useful File Locations * `/some/special/script.sh` - List special scripts * `/magic/dir` - And also directories ## Built With * List the software v0.1.3 * And the version numbers v2.0.0 * That are in this container v0.3.2 ## Contributing Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. ## Versioning We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/repository/tags). ## Authors * **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) See also the list of [contributors](https://github.com/your/repository/contributors) who participated in this project. ## License This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. ## Acknowledgments * People you want to thank * If you took a bunch of code from somewhere list it here