This repository has been archived by the owner on Nov 14, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5822a4f
commit 3fe12c8
Showing
1 changed file
with
37 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |