chore: update readme file

.github/workflows/release-package.yml

@@ -23,18 +23,12 @@ jobs:
           yarn install
           yarn build
 
-      - name: Setup git profile
-        run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-
       - name: Publish to NPM
         id: publish
         uses: JS-DevTools/npm-publish@v2
         with:
           token: ${{ secrets.NPM_TOKEN }}
           package: "./package.json"
-          dry-run: ${{ github.event.inputs.dry-run }}
 
       - if: ${{ steps.publish.outputs.type != 'none' }}
         run: |

README.md

@@ -1,3 +1,45 @@
 # Squid Types
 
-Squid types used on the graph, api and sdk
+Squid types used on the graph, api and sdk.
+
+### LINTER & PRETTIER
+
+This project has installed prettier and linter rules, with husky we ensure pre-commit and pre-push validation.
+
+```bash
+yarn lint
+```
+
+```bash
+yarn lint:fix
+```
+
+```bash
+yarn format
+```
+
+### VSCODE
+
+Create `.vscode/setting.json` for auto-saving linter and prettier format
+
+```json
+{
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}
+```
+
+# RELEASE
+
+NPM package publish is automated with github actions, follow these steps:
+
+1 - Create a PR to `develop` branch updating `package.json` version. (review, approve and merge)
+
+2 - Create a PR from `develop` to `main`. (review, approve and merge)
+
+Once the PR to `main` is merged, this commit on this branch gonna trigger automatically the release to NPM, please make sure you update correctly the version.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsquid/squid-types",
-  "version": "0.1.45",
+  "version": "0.1.46",
   "description": "JS and TS types relating to 0xsquid related projects.",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",