Skip to content

Commit

Permalink
[README] add readme details
Browse files Browse the repository at this point in the history
  • Loading branch information
kariae committed Aug 14, 2018
1 parent 629ebc2 commit 081f80b
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 4 deletions.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,42 @@

Composei is an interactive command line tool build with golang that helps you create your docker compose file.

Cause yes I'm lazy to remember all the possible options for each container xD
Cause I'm too lazy to remember all the possible options for each container xD

# Installation
Run

go get -u github.com/kariae/composei

# Usage

$ composei -h
NAME:
Composei - Composei is an interactive command line tool build with golang that helps you create your docker compose file.

USAGE:
main [global options] command [command options] [arguments...]

VERSION:
0.1.0

COMMANDS:
generate, g Generate docker compose file
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version

# TODOs
- [ ] Add more details to README file.
- [ ] Automate releases generation.
- [ ] Add travis automation for tests.

# Contributing
First, **many thanks** for your contributions, please note that this eco system is a personal preference that I use in most of my PHP projects (using Symfony or other frameworks), if you find any typo/misconfiguration, or just want to optimize more the workflow, please
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
7 changes: 4 additions & 3 deletions commands/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"bufio"
"os"
"github.com/kariae/composei/env"
"github.com/kariae/composei/version"
)

var GenerateCommand = cli.Command{
Expand Down Expand Up @@ -83,7 +84,7 @@ func generate(c *cli.Context) {
}

// Display generation message
logger.Green(`Congratulation your docker compose configuration file is created.`)
fmt.Println(logger.Green(`Congratulation your docker compose configuration file is created.`))
}

// generateData starts the process of generating top levels attributes
Expand Down Expand Up @@ -245,10 +246,10 @@ func PrintComposeiAsciiArt() {
+-------+-------+ \____\___/|_| |_| |_| .__/ \___/|___/\___|_|
|_|
By Zakariae Filali - 0.0.1
By Zakariae Filalis - %s
https://github.com/kariae/composei
`
fmt.Println(logger.Green(composei))
fmt.Println(logger.Green(fmt.Sprintf(composei, version.Version.String())))
}

0 comments on commit 081f80b

Please sign in to comment.