Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
egorlem committed Jan 9, 2025
1 parent a0127b1 commit d5134e7
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions .ABOUT.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ The library extends the `ApolloLink` from `@apollo/client` and provides a custom

## Installation
Node Package Manager installation
```zsh
```shell
npm install apollo-link-printer
```
Yarn installation
```zsh
```shell
yarn add apollo-link-printer
```
---
Expand Down Expand Up @@ -74,31 +74,30 @@ In this example, `PrinterLink` is added to the Apollo Client link chain. The `op
This project uses TypeScript to provide static typing for JavaScript and Jest for testing. To contribute, follow these steps:

1. Clone the repository:
```zsh
```shell
git clone https://github.com/egorlem/apollo-link-printer.git
```

```zsh
```shell
cd apollo-link-printer
```

2. Install dependencies:
```zsh
```shell
npm install # or `yarn`
```

3. Make your changes and run tests to ensure everything works as expected:
```zsh
```shell
npm test # or `yarn test`
```

4. To run the library locally in another project, you can link it:
```zsh
```shell
npm link
```
```zsh
# In the project where you want to use the library
npm link apollo-link-printer
```shell
npm link apollo-link-printer # In the project where you want to use the library
```

5. Commit and push your changes, then open a pull request on GitHub.
Expand Down

0 comments on commit d5134e7

Please sign in to comment.