Skip to content

Commit

Permalink
Trim README for now.
Browse files Browse the repository at this point in the history
  • Loading branch information
bglw committed Jun 25, 2024
1 parent 86356dc commit 3a463a2
Showing 1 changed file with 0 additions and 69 deletions.
69 changes: 0 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,72 +6,3 @@ This is used as a library within the CMS itself, but you can use it to generate
file locally.

[<img src="https://img.shields.io/npm/v/@cloudcannon%2Fgadget?logo=npm" alt="version badge">](https://www.npmjs.com/package/@cloudcannon%2Fgadget)

---

- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [License](#license)

---

## Installation

```bash
npm i -g @cloudcannon/gadget
```

This gives you access to the `cloudcannon-gadget` binary.

## Usage

For usage details:

```sh
cloudcannon-gadget --help
```

Which outputs:

```
Inpects a list of files to create configuration for the CloudCannon CMS.
Usage
cloudcannon-gadget <input> [options]
Options
--version Print the current version
Examples
cloudcannon-gadget .
cloudcannon-gadget sites/my-jekyll-site
```

---

## Development

Install dependencies:

```sh
npm i
```

Run tests:

```sh
npm test
npm run test:watch
npm run test:coverage
```

Lint code:

```sh
npm run lint
```

## License

MIT

0 comments on commit 3a463a2

Please sign in to comment.