Skip to content

Commit

Permalink
Add section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
abmruman committed Feb 17, 2020
1 parent 1b3fd84 commit 3197505
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
# docker-compose-project

## A template for docker-compose projects
**A template for docker-compose projects.**

### How to use
## Content: (Templates and scripts)

- [scripts](scripts) (convenient scripts for frequently used, necessary commands)
- [.editorconfig](https://editorconfig.org/) `*`
- [.gitignore](https://help.github.com/en/github/using-git/ignoring-files) `*`
- [.pre-commit-config.yaml](https://pre-commit.com/) (`pre-commit install`) `*`
- [.travis.yml](https://docs.travis-ci.com/) (`travis lint .travis.yml`) `**`
- [Dockerfile](https://docs.docker.com/engine/reference/builder/) `**`
- [LICENSE](https://choosealicense.com/) (MIT) `*`
- [Makefile](https://opensource.com/article/18/8/what-how-makefile) (for commands: `make`, `make clean`, etc.) `*`
- [README.md](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) `**`
- [docker-compose.yml](https://docs.docker.com/compose/compose-file/) `**`
- [env.example](https://docs.docker.com/compose/compose-file/#env_file) `**`

_`*` Can be used out-of-the-box or change as needed for your project._

_`**` Requires changing to suit your project's need._

## How to use

- Fork and select this as template when creating a new repo on Github
- Or click on `Use this template` and create a new repo on Github
- Or click on `Use this template` on this [repo](https://github.com/abmruman/docker-compose-project) and create a new repo on Github
- Or clone/download and use locally
- Modify `docker-compose.yml`
- Modify `Dockerfile`
Expand All @@ -14,6 +32,6 @@
- Run `make up` to start containers
- Run `make down` to stop/remove containers
- Run `make clean` to clean up and start fresh
- Or use the [scripts](scripts) directly. i.e. `./scripts/init.sh`, `./scripts/build.sh`
- Or use the [scripts](scripts) directly. _i.e._ [`./scripts/init.sh`](scripts/init.sh), [`./scripts/build.sh`](scripts/init.sh)

_Refer to Makefile to see the recipes._
_Refer to [`Makefile`](Makefile) to see the recipes._

0 comments on commit 3197505

Please sign in to comment.