make cdk publicly available (#32)

* update org scope peer dependencies to use npm public pacakages, update readme

* add SECURITY.md

* update actions to remove npmrc creation

* remove examples

* lockfile

Author: bretth18

.github/workflows/lint.yml

@@ -14,12 +14,6 @@ jobs:
         with:
           node-version: 14.17.6
 
-      - name: Create NPMRC
-        run: |
-          echo "//npm.pkg.github.com/:_authToken=${{ secrets.PACKAGES_TOKEN }}" >> ~/.npmrc
-          echo "@catalogworks:registry=https://npm.pkg.github.com" >> ~/.npmrc
-          echo 'registry "https://registry.yarnpkg.com"' >> ~/.yarnrc
-
       - name: code checkout
         uses: actions/checkout@v2
 

.github/workflows/nodejs-tests.yml

@@ -3,7 +3,6 @@ name: nodejs-tests
 on: [push, pull_request]
 
 jobs:
-
   test:
     runs-on: ubuntu-latest
 
@@ -16,13 +15,6 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: 14.17.6
-          
-      - name: Create NPMRC
-        run: |
-            echo "//npm.pkg.github.com/:_authToken=${{ secrets.PACKAGES_TOKEN }}" >> ~/.npmrc
-            echo "@catalogworks:registry=https://npm.pkg.github.com" >> ~/.npmrc
-            echo 'registry "https://registry.yarnpkg.com"' >> ~/.yarnrc
-
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
@@ -36,20 +28,18 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-yarn-
 
-
       - name: Installing dependencies
         run: yarn install --frozen-lockfile
 
       - name: start blockchain
         run: yarn chain &
 
-      # - run: 
+      # - run:
       #     shell: /bin/sh
       #     command: |
       #           wget --retry-connrefused --waitretry=1 --read-timeout=20 --timeout=15 -t 10 http://localhost:8545
       #           :
       #     name: wait for chain and override shell
 
-
       - name: Running tests
-        run: yarn test
+        run: yarn test

.npmrc

@@ -1 +1 @@
-@catalogworks:registry=https://npm.pkg.github.com
+@catalogworks:registry=https://registry.npmjs.org/

README.md

@@ -11,16 +11,14 @@
 
 ```
 
-WIP Repo
-
 ---
 
 ## Info
 
-The Catalog Development Kit (**CDK**) is a small set of tools to easily and safely interact with Catalog contracts and protocols.
+The Catalog Development Kit (**CDK**) is a small set of tools to easily and safely interact with Catalog contracts and related Zora market contracts.
 The CDK is written in TS and can be used in any JS environment.
 
-This repository is based on the [Zora ZDK](https://github.com/ourzora/zdk).
+This repository is based on the [Zora ZDK (original version)](https://github.com/ourzora/zdk).
 
 The CDK has these primary exports plus some types:
 
@@ -45,20 +43,11 @@ The CDK has these primary exports plus some types:
 [Package](https://github.com/catalogworks/cdk/packages/1173720)
 
 ```bash
-yarn add @catalogworks/cdk@0.3.2
+yarn add @catalogworks/cdk
 ```
 
 ---
 
-### Examples
-
-Example usage of the CDK in a NodeJS environment can be found in the [examples](./examples) directory.
-
-- [tree+proofs+root](./examples/scripts/treeproofdb.ts)
-- [gnosissafe](./examples/scripts/connectsafe.ts)
-
----
-
 ### Development
 
 ```bash
@@ -69,12 +58,6 @@ git clone https://github.com/catalogworks/cdk.git
 cd cdk
 ```
 
-_Note: you may need to do the following before being able to install packages_
-
-- In GitHub, go to settings > developer settings > personal access tokens
-- Generate new access token with permission `read:packages`
-- Add the following line to bottom of .npmrc `//npm.pkg.github.com/:_authToken=<Your Access Token>`
-
 ```bash
 yarn
 ```
@@ -126,6 +109,8 @@ Reports are located in the `./coverage` directory.
 
 View: [LICENSE](./LICENSE)
 
+Zora related code is licensed under [MIT](https://github.com/ourzora/zdk/blob/v1-archive/LICENSE)
+
 ---
 
 ### Changelog
@@ -134,9 +119,16 @@ View: [LICENSE](./LICENSE)
 
 ---
 
+### Contributing
+
+This package is designed specifically for usage at Catalog, and development for this package is handled internally. Creating an issue is welcome for any security related contributions from developers outside of our organization.
+
+Please create a fork of this repository for your own personal needs.
+
 ### Dependencies
 
-- [@catalogworks/catalog-contracts@0.1.4](https://github.com/catalogworks/catalog-contracts/packages/1165811)
+- [@catalogworks/catalog-contracts](https://www.npmjs.com/package/@catalogworks/catalog-contracts)
+- [@catalogworks/zorav3-with-types](https://www.npmjs.com/package/@catalogworks/zorav3-with-types)
 - Ethers
 - sjcl
 - tiny-invariant

SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+- All versions
+
+## Reporting a Vulnerability
+
+External Contributors / Community Auditors:
+
+- Please [open an issue](https://github.com/catalogworks/cdk/issues/new) detailing the vulnerability discovered.
+- If this is a **serious** immediate issue, please reach out via Discord, Slack, or [email](mailto:[email protected])