Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RomKadria committed Feb 25, 2024
1 parent 18e7059 commit c612e30
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions packages/setup-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,21 @@ your types will be ready to use (as can be seen in the generated folder)

## Installation

This library is intended to be installed globally, allowing you to set up any project easily. To install, open your terminal and run:

To install locally in your project:
Run this command on the **root** of your project

```bash
npx @mondaydotcomorg/setup-api
```

## Running the Setup

With the library installed and the appropriate permissions set, you can now run the setup process in the root directory of your project. Simply execute the following command:
If you prefer to install in locally or globally, you can. afterwards run the setup process in the **root** directory of your project. Simply execute the following command:

```bash
setup-api-monday
```

This command will initiate the library's setup process, automatically configuring your project environment for development with the Monday API and GraphQL.
## Using the newly created scripts

Afterwards, there will be created 3 scripts.
After installatiom, you will have 3 new scripts:
"fetch:schema" - Gets the monday api schema
"codegen" - generates types
"fetch:generate" - runs both
Expand Down

0 comments on commit c612e30

Please sign in to comment.