Readme Fix and Action for Publishing to github (#18)

* feat(typescript): added autocomplete types

* feat(typescript): added retrieve, enrichment, cleaner and identity types

* feat(typescript): finished all endpoints and added types to errors

* feat(typescript): added types to examples

* feat(typescript): fixes based on questions

* feat(typescript): added pretty param to all endpoints

* feat(typescript): added rate limiting data and types

* feat(typescript): fixed bulk test

* feat(typescript): bumped to version 2.0.0

* fix readme

* fixes

* update readme and add pr template

* add github publish

* update token

Co-authored-by: Diego Abizaid <diegoabizaid@gmail.com>

.github/pull_request_template.md

@@ -0,0 +1,10 @@
+## Description of the change
+
+> Description here
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] Chore (cleanup or minor QOL tweak that has little to no impact on functionality)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

.github/workflows/publish.yaml

@@ -1,4 +1,4 @@
-name: Publish Package
+name: Publish Packages to NPM and Github
 
 on:
   release:
@@ -30,3 +30,17 @@ jobs:
       - run: yarn run pub
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+
+  publish-gpr:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://npm.pkg.github.com/
+      - run: yarn
+      - run: yarn run pub
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GH_TOKEN}}

README.md

@@ -19,7 +19,6 @@ This library bundles up PDL API requests into simple function calls, making it e
 
 ## ✨ Features
 - Tiny <2KB size gzip
-- Works in Node.js and in Browser
 - Supports all People Data Labs API endpoints
 - Built-in Typescript support