Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mindsers committed Sep 24, 2017
1 parent d3f264d commit a3bb4df
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# configfiles

**configfiles** is a command line tool that help user to manage their own configuration files.

## Data storage

This tool does not store configuration files for you. A git repo is needed to store your configuration files.

Please follow this structure:

```txt
/files/
/module1/
/module2/
/settings.json
/configurationfile.txt
/module3/
/scripts/
/scriptfile.sh
```

## Usage

### Initialization / configuration

`configfiles init` Initialize *configfiles* on the current user session.

### Deploy configuration files

`configfiles deploy [moduleName...]` Deploy the configuration files for the given module name.

### Run script

`configfiles run <scriptName>` Execute the script identifying by the given script name.

## License

This project is under Apache-2.0 license. See LICENSE file.

0 comments on commit a3bb4df

Please sign in to comment.