Skip to content

Commit 3c2e26c

Browse files
committed
chore: updated readme
1 parent 4ce1e7c commit 3c2e26c

File tree

1 file changed

+38
-14
lines changed

1 file changed

+38
-14
lines changed

Readme.md

+38-14
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,63 @@
11
> Once you head down the GraphQL's path
22
> forever will it dominate your destiny.
33
4+
[![GitHub Stars](https://img.shields.io/github/stars/graphql-editor/graphql-editor-cli.svg)](https://github.com/graphql-editor/graphql-editor-cli)
5+
[![GitHub Issues](https://img.shields.io/github/issues/graphql-editor/graphql-editor-cli.svg)](https://github.com/graphql-editor/graphql-editor-cli/issues)
6+
[![Version](https://img.shields.io/npm/v/gei-bookings.svg)](https://www.npmjs.com/package/gei-bookings)
7+
[![Build Status](https://github.com/graphql-editor/graphql-editor-cli/actions/workflows/release.yml/badge.svg)](https://github.com/graphql-editor/graphql-editor-integrations/actions?query=branch%3Amaster)
8+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](https://github.com/graphql-editor/graphql-editor-cli/pulls)
9+
410
# GraphQL Editor Cli
511

6-
Compatible with [GraphQL Editor](https://graphqleditor.com) projects( Free and Paid Tiers). The main goal is to provide interactive experience creating GraphQL as a service.
12+
> Compatible with [GraphQL Editor](https://graphqleditor.com) our CLI works seamlessly with your projects on both the free and paid plans. Its main goal is to enhance your interactive experience and provide tools for working with GraphQL as a service.
713
814
## Requirements
915

1016
- [GraphQL Editor](https://graphqleditor.com)
1117
- NodeJS >= 16
1218

13-
- [GraphQL Editor Cli](#graphql-editor-cli)
14-
- [Requirements](#requirements)
15-
- [Installation](#installation)
16-
- [Global](#global)
17-
- [Inside Repo](#inside-repo)
18-
- [Docs](#docs)
19+
## Installation :zap:
20+
21+
Let's go over the installation process step by step.
1922

20-
## Installation
23+
### Global :earth_africa:
2124

22-
### Global
25+
First to install globally use the following command:
2326

2427
```sh
2528
npm i -g graphql-editor-cli
2629
```
2730

28-
### Inside Repo
31+
### Inside Repo :house:
32+
33+
then install it in your repository using this one:
2934

3035
```sh
3136
npm i -D graphql-editor-cli
3237
```
3338

34-
then use with npx for example or as a `package.json` script.
39+
That's it! Now you can use it freely, for example with npx or as a `package.json` script.
40+
41+
## Author
42+
43+
👤 **Artur Czemiel**
44+
45+
- Website: https://graphqleditor.com
46+
- Github: [@Aexol](https://github.com/aexol)
47+
48+
## 🤝 Contributing
49+
50+
Contributions, issues and feature requests are welcome!
51+
52+
Feel free to check our [issues page](https://github.com/graphql-editor/graphql-editor-cli/issues).
53+
54+
## :scroll: Docs
55+
56+
If you want to know more our docs are available here:
57+
[GraphQL editor docs](https://graphqleditor.com/docs/tools/graphql-cli/)
58+
59+
## 📝 License
3560

36-
## Docs
61+
Copyright © 2023 [GraphQL Editor](https://github.com/graphql-editor).
3762

38-
Docs are available here:
39-
[https://graphqleditor.com/docs/tools/untitled/README/](https://graphqleditor.com/docs/tools/untitled/README/)
63+
This project is [MIT](https://github.com/graphql-editor/graphql-editor-integrations/blob/master/LICENSE) licensed.

0 commit comments

Comments
 (0)