Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fwuensche committed Dec 7, 2024
1 parent 9734a1e commit 686943b
Showing 1 changed file with 20 additions and 35 deletions.
55 changes: 20 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,35 @@
# Initial setup ⚡️
# Initial Setup ⚡️

Install the CLI globally with:
## 1. Install the CLI

```sh
```
npm install -g cherrypush
```

Inside the root of your project, initialize your cherry configuration:

```sh
cherry init
```
## 2. Initialize Cherry

Add your API key into a .env file at the root of your project:
Go to your project’s root directory and run:

```sh
CHERRY_API_KEY=YOUR_API_KEY
```
cherry init
```

You can find your API key at https://www.cherrypush.com/user/settings
This command creates a `.cherry.js` configuration file tailored to your repository, as well as a GitHub Actions workflow
file to automate the submission of your metrics.

# CLI commands 😌
## 3. Add Your API Key

## cherry init
Create a `.env` file in your project’s root directory and add:

The init command will initialize your config file `.cherry.js` and create a sample GitHub workflow file that you can use
to integrate Cherry to your CI/CD workflow via GitHub Actions.
```
CHERRY_API_KEY={{YOUR_API_KEY}}
```

A very minimal config file can look something like this:
You can find your API key by visiting [your Cherry account settings](https://www.cherrypush.com/user/settings).

```js
module.exports = {
project_name: 'PROJECT_NAME',
plugins: { loc: {} }, // Add metrics about number of lines of code
metrics: [
{
name: 'TODO/FIXME',
pattern: /(TODO|FIXME):/i, // the i flag makes the regex case insensitive
},
],
}
```
With that, you’re ready to start tracking your codebase metrics!

For more info about CI/CD integration, refer to the Integrations section below.
# CLI Commands 😌

## cherry run

Expand Down Expand Up @@ -281,9 +268,7 @@ cherry_push:
- main
```

# Feedback 🙏

Any further question or suggestion?
# Feedback 💌

- report a bug or suggest new features via [GitHub Issues](https://github.com/cherrypush/cherry-cli/issues)
- or shoot me a message on [twitter.com/fwuensche](https://twitter.com/fwuensche)
We’d love to hear from you! If you find a bug or have a suggestion, please open an issue on our
[GitHub Issues](https://github.com/cherrypush/cherry-cli/issues). Your input is what makes Cherry better for everyone.

0 comments on commit 686943b

Please sign in to comment.