Skip to content

Commit

Permalink
Updated project README with a proper TODO list
Browse files Browse the repository at this point in the history
  • Loading branch information
vovimayhem committed Aug 18, 2016
1 parent 88ea600 commit a019659
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ See ([Releases Page](https://github.com/IcaliaLabs/plis/releases))

## Special behaviors:
* `plis start [services-optional]`: Starts a docker-compose project, with the following extra functionality:
* (TODO) If Docker Toolbox is not installed, it will try to install it.
* (TODO) If a default machine is not present, it will try to create one.
* (TODO) If there are missing dotenv files being referenced in the docker-compose.yml file:
* If there's a \*.example.env dotenv template file, it copies it as \*.env
* It there's no example dotenv template to copy, it creates a blank new one
* If some or all of the requested project's containers are missing, issues a `docker-compose up -d` command.
* If all of the requested project's containers are present, issues a `docker-compose start` command.
* `plis attach [service_name]`: It figures out the given service's container, and attaches the console to it.
Expand All @@ -41,3 +36,11 @@ plis run web rails c
plis stop web

```

## TODO's:
- [ ] `build` command to invoke the docker-compose build command.
- [ ] Change the `run` command to use `docker-compose exec` instead of `docker exec` whenever a running container is already available.
- [ ] Copy (from existing templates/examples) or generate blank dotenv files referenced in the Compose file.
- [ ] Install Docker (for Mac/Windows or native for Linux) if it is missing.
- [ ] Make `plis start github.com/some_org/some_dockerized_app` clone the project and run it.
- [ ] `upgrade` command that upgrades `plis` to the newest version.

0 comments on commit a019659

Please sign in to comment.