Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

Commit

Permalink
Fills README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jedrzejchalubek committed Apr 28, 2017
1 parent 5822a4f commit 3fe12c8
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
[![Build Status](https://travis-ci.org/tonik/cli.svg?branch=master)](https://travis-ci.org/tonik/cli) [![Coverage Status](https://coveralls.io/repos/github/tonik/cli/badge.svg?branch=master)](https://coveralls.io/github/tonik/cli?branch=master)
# Tonik — CLI

[![Build Status](https://travis-ci.org/tonik/cli.svg?branch=master)](https://travis-ci.org/tonik/cli) [![Coverage Status](https://coveralls.io/repos/github/tonik/cli/badge.svg?branch=master)](https://coveralls.io/github/tonik/cli?branch=master)

### Simple CLI for initiating themes based on [Tonik WordPress Starter Theme](https://github.com/tonik/tonik).

## Installing

You can install package via Composer.

```bash
# Install composer dependencies.
$ composer require tonik/cli
```

## Usage

Package provides binary script inside Composer `vendor` directory which you can run by typing:

```bash
# Run setup wizard.
$ vendor/bin/tonik
```

## Contributing

Great that you are considering supporting the project. You have a lot of ways to help us grow. We appreciate all contributions, even the smallest.

- Report an issue
- Propose a feature
- Send a pull request
- Star project on the [GitHub](https://github.com/tonik/cli)
- Tell about project around your community

## License

Licensed under the [MIT license](http://opensource.org/licenses/MIT).

0 comments on commit 3fe12c8

Please sign in to comment.