v0.0.8

* Added documentation
* Added Tests
* Added github actions to test in each PR

.env.template

@@ -0,0 +1 @@
+POAP_API_KEY=

.github/workflows/npm_publish.yml

@@ -11,7 +11,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Set up Node.js
       uses: actions/setup-node@v3

.github/workflows/run-tests.yml

@@ -9,17 +9,21 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [16.x]
-
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v3
       with:
-        node-version: ${{ matrix.node-version }}
+        node-version: '16.x'
+        registry-url: 'https://registry.npmjs.org'
+
     - name: Install dependencies
-      run: yarn install
+      run: yarn install --frozen-lockfile
+
+    - name: Build packages
+      run: yarn build
+
     - name: Run tests
       run: yarn test

.gitignore

@@ -2,9 +2,11 @@ node_modules
 dist
 coverage
 .env
+docs/.yarn/
 .yarn/*
 !.yarn/patches
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
-!.yarn/versions
+!.yarn/versions
+.next

README.md

@@ -1,5 +1,91 @@
-# poap.js
+# POAP.js
 
+The POAP.js is a collection of SDKs and utilities for interacting with the POAP ecosystem. The library provides a set of classes and methods to simplify working with them.
+
+## Table of Contents
+
+- [POAP.js](#poapjs)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+  - [Development](#development)
+  - [Examples](#examples)
+  - [Documentation](#documentation)
+  - [Contributing](#contributing)
+  - [Active contributors](#active-contributors)
+  - [License](#license)
+
+## Features
+
+- Handle moments creation and management
+- TypeScript support with strong typing
+- Easy integration with the POAP ecosystem
+
+## Development
+
+To start developing the POAP Package Library, follow these steps:
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/poap-xyz/poap.js.git
+```
+
+2. Have yarn installed:
+
+```bash
+npm install -g yarn
+```
+
+3. Install dependencies:
+
+```bash
+yarn install
+```
+
+4. Build the packages:
+
+```bash
+yarn build
+```
+
+5. Run the tests:
+
+```bash
+yarn test
+```
+
+## Examples
+
+The `examples` folder contains various examples to help you understand how to use the POAP Package Library. To run these examples, follow these steps:
+
+1. Replace the placeholder `'your_api_key'` with your actual API key in the example files.
+2. Run the examples using the `yarn start` command.
+
+Inside the `examples` folder, you'll find subfolders for each method, showcasing different ways to interact with each client.
+
+Feel free to explore these examples to learn how to use the library effectively and get a better understanding of the available functionality.
+
+## Documentation
+
+The library is well-documented using TypeDoc. To generate the documentation, run the following command:
+
+```bash
+yarn docs
+```
+
+The generated documentation will be available in the docs/ directory.
+
+## Contributing
+
+Contributions to the POAP Package Library are welcome. To contribute, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch with a descriptive name.
+3. Make your changes and commit them with a clear and concise commit message.
+4. Create a pull request, describing the changes you made and why.
+5. Wait for a maintainer to review your pull request and provide feedback.
+
+Please ensure that your code adheres to the project's code style and passes all tests before submitting a pull request.
 
 ## Active contributors
 <!-- ALL-CONTRIBUTORS-LIST:END -->

docs/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Shu Ding
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/README.md

@@ -1,3 +1,24 @@
-poap.js / [Modules](modules.md)
+# POAP.js Documentation Website
 
-# poap.js
+This is a documentation website for POAP.js, a library for integrating with the POAP (Proof of Attendance Protocol) platform in JavaScript applications.
+
+## Getting Started
+
+To get started with this website, you'll need to install its dependencies and start the development server. You can do this using NPM:
+
+### NPM
+
+```bash
+npm install
+npm run dev
+```
+
+Once the development server is running, you can view the website in your web browser by navigating to `http://localhost:3000`.
+
+## Contributing
+
+We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines.
+
+## License
+
+@poap-xyz/drops is released under the [MIT License](https://opensource.org/licenses/MIT).