diff --git a/README.md b/README.md index 50ea7ef1b..89957ee57 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,35 @@ -## dockerfiles +# Dockerfiles 🐳 + +This is a repo to hold various Dockerfiles for images I create. [![Travis CI](https://img.shields.io/travis/jessfraz/dockerfiles.svg?style=for-the-badge)](https://travis-ci.org/jessfraz/dockerfiles) -This is a repo to hold various Dockerfiles for images I create. +Almost all of these live on dockerhub under [jess](https://hub.docker.com/u/jess/). +Because you cannot use notary with autobuilds on dockerhub I also build these continuously on a private registry at [r.j3ss.co](https://r.j3ss.co/) for public download. (You're welcome.) -**Table of Contents** +## Index - + + -- [About](#about) - [Resources](#resources) - * [My dotfiles](#my-dotfiles) + - [My dotfiles](#my-dotfiles) +- [Using the `Makefile`](#using-the-makefile) - [Contributing](#contributing) - * [Using the `Makefile`](#using-the-makefile) +- [License](#license) - - -## About - -Almost all of these live on dockerhub under [jess](https://hub.docker.com/u/jess/). -Because you cannot use notary with autobuilds on dockerhub I also build these -continuously on a private registry at [r.j3ss.co](https://r.j3ss.co/) for public download. (You're -welcome.) + ## Resources ### My dotfiles -You may also want to checkout my [dotfiles](https://github.com/jessfraz/dotfiles), specifically the aliases for all these files which are here: [github.com/jessfraz/dotfiles/blob/master/.dockerfunc](https://github.com/jessfraz/dotfiles/blob/master/.dockerfunc). - -## Contributing - -I try to make sure each Dockerfile has a command at the top to document running it, -if a file you are looking at does not have a command, please -pull request it! +You may also want to cMarkdown TOCthub.com/jessfraz/dotfiles/blob/master/.dockerfunc). +## Using the `Makefile` -### Using the `Makefile` - -``` +```bash $ make help build Builds all the dockerfiles in the repository. dockerfiles Tests the changes to the Dockerfiles build. @@ -48,4 +38,16 @@ latest-versions Checks all the latest versions of the Dockerfile run Run a Dockerfile from the command at the top of the file (ex. DIR=telnet). shellcheck Runs the shellcheck tests on the scripts. test Runs the tests on the repository. -``` \ No newline at end of file +``` + +## Contributing + +I try to make sure each Dockerfile has a command at the top to document running it, +if a file you are looking at does not have a command, please +pull request it! + +## License + +This repository is licensed under [MIT License](LICENSE) + +Copyright (c) 2017 [Jessie Frazelle](https://github.com/jessfraz)