From 3a463a22cab57eee84f49527e84dde6a95173886 Mon Sep 17 00:00:00 2001 From: Liam Bigelow <40188355+bglw@users.noreply.github.com> Date: Tue, 25 Jun 2024 14:16:17 +1200 Subject: [PATCH] Trim README for now. --- README.md | 69 ------------------------------------------------------- 1 file changed, 69 deletions(-) diff --git a/README.md b/README.md index 2cc6367..8a09783 100644 --- a/README.md +++ b/README.md @@ -6,72 +6,3 @@ This is used as a library within the CMS itself, but you can use it to generate file locally. [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 [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