Skip to content

Commit

Permalink
Merge pull request #54 from ipetinate/fix/update-main-readme
Browse files Browse the repository at this point in the history
fix: update docs
  • Loading branch information
ipetinate authored Jun 25, 2024
2 parents fb6d489 + 3f48596 commit f914eb6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 44 deletions.
58 changes: 15 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,63 +48,35 @@ By default, it already comes with some settings, which are commonly used concept

Answer a questionnaire with a few questions in guided mode (if you don't know exactly what you want, or if you're a beginner and need the code ready to start coding), or use advanced mode by selecting custom models that you created and added to the root of your project.

In the initial version, we have not yet made advanced mode available, it will be released in future updates.

## How to use

Install the tool globally using your preferred Node package manager, or use `npx` to run the executable.

Note: Maybe on macOS you do not have permission to run the tool if you install it globally, if this happens you need to give the correct permissions or to avoid anything you can use `npx` which solves this problem.

- Using `npx`

```shell
npx clingon@latest gen

# or

npx clingon create ResourceName --preset preset-name
```

- Using node package manager

- Install

```shell
npm i -g clingon

# or
```shell

yarn add -g clingon
npx clingon@latest gen

# or
# or

pnpm i -g clingon
npx clingon@latest init

```
# or

- Execute
npx clingon@latest create ResourceName --preset preset-name

```shell
clingon gen
# or

# or
npx clingon create ResourceName --preset preset-name
```

- Composing with arguments and options

```shell
clingon gen <ResourceName>
# or
npx clingon create ResourceName --preset preset-name
```

- You can pass Resource name as argument after `gen` command, read more about on [Arguments doc](https://www.clingon.dev/docs/arguments).
npx clingon@latest scaffold ResourceName --template template-name
```

## Command modes

Read more on: [clingon.dev/docs/guide/commands](https://www.clingon.dev/docs/guide/commands)

- Commands shortcuts
- `init`: [Init doc](https://www.clingon.dev/docs/guide/commands#init-command)
- `gen`: [Gen doc](https://www.clingon.dev/docs/guide/commands#gen-command)
- `create`: [Create doc](https://www.clingon.dev/docs/guide/commands#create-command)
- `scaffold`: [Scaffold doc](https://www.clingon.dev/docs/guide/commands#scaffold-command)
2 changes: 1 addition & 1 deletion src/templates/core/SCAFFOLD_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ interface Meta {
- path: src/components
template: ./ReactComponent/Component.tsx
- path: src/components
tempalte: ./ReactComponent/Component.spec.tsx
template: ./ReactComponent/Component.spec.tsx
- path: src/components
template: ./ReactComponent/Component.stories.tsx
- path: src/components
Expand Down

0 comments on commit f914eb6

Please sign in to comment.