prepare for release 1.0.0

.github/workflows/npm-publish.yml

@@ -8,10 +8,10 @@ jobs:
   publish-npm:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           registry-url: https://registry.npmjs.org/
       - run: yarn
       - run: yarn build

.github/workflows/yarn-build-and-test.yml

@@ -9,10 +9,10 @@ jobs:
   test:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: "npm"
       - run: yarn
       - run: yarn build

.nvmrc

@@ -0,0 +1 @@
+v20

README.md

@@ -1,8 +1,29 @@
-## typescript-package
+## protoc-gen-graphql
 
-Template for building node packages using Typescript
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=viqueen_protoc-gen-graphql&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=viqueen_protoc-gen-graphql)
 
-### environment
+Protoc plugin to generate GraphQL schema from protobuf schema.
+
+### install it
+
+#### from stable
+
+- with **homebrew** (preferred)
+
+```bash
+brew tap viqueen/labset
+brew install protoc-gen-graphql
+```
+
+- with **npm**
+
+```bash
+npm install @labset/protoc-gen-graphql -g
+```
+
+### development
+
+#### environment
 
 - **[nvm](https://github.com/nvm-sh/nvm)** to manage node versions.
 
@@ -16,7 +37,14 @@ brew install nvm
 brew install yarn
 ```
 
-### house-keeping
+#### house-keeping
+
+- install dependencies
+
+```bash
+nvm install
+yarn
+```
 
 - build it
 

package.json

@@ -1,6 +1,8 @@
 {
   "name": "@labset/protoc-gen-graphql",
-  "version": "0.0.1",
+  "version": "1.0.0",
+  "description": "A protoc plugin to generate GraphQL schema from protobuf files",
+  "preferGlobal": false,
   "repository": "[email protected]:viqueen/protoc-gen-graphql.git",
   "author": "Hasnae R. <>",
   "license": "Apache-2.0",