@poap-xyz/poaps - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1-beta-v2

package.json

 {
   "name": "@poap-xyz/poaps",
-  "version": "0.1.0",
+  "version": "0.1.1-beta-v2",
   "description": "Poaps module for the poap.js library",
@@ -34,3 +34,4 @@ "main": "dist/cjs/index.cjs",
     "node": ">=18"
-  }
+  },
+  "stableVersion": "0.1.1"
 }

README.md

@@ -5,15 +5,20 @@ # @poap-xyz/poaps
 
-`@poap-xyz/poaps` is a package to fetch information about POAPs tokens, their on-chain data, their related drop and metadata.
+`@poap-xyz/poaps` is a JavaScript library providing an interface for interacting with POAPs , making it easy to fetch information about POAP tokens like their on-chain data, their related drop information and metadata.
 
 ## Features
 
-- Fetch a single POAP token,
-- Search over minted POAPs by their collector or the drop they belong.
+- Fetch one or multiple POAP tokens at once.
+- Search over minted POAPs by their collector or the drop they belong to.
+- Mint POAPs synchronously or asynchronously mint processes.
+- Reserve a POAP to an email address.
+- Obtain mint status, POAP indexed status, and more.
 
 ## Installation
 
+This package doesn't require any additional dependencies for installation.
+
 ### NPM
 
 ```bash
-npm install @poap-xyz/poaps @poap-xyz/utils @poap-xyz/providers axios form-data
+npm install @poap-xyz/poaps
 ```
@@ -24,3 +29,3 @@
 ```bash
-yarn add @poap-xyz/poaps @poap-xyz/utils @poap-xyz/providers axios form-data
+yarn add @poap-xyz/poaps
 ```
@@ -31,7 +36,22 @@
 ```javascript
-  import { PoapsClient } from '@poap-xyz/poaps';
-  import { PoapCompass } from '@poap-xyz/providers';
+import { PoapsClient } from '@poap-xyz/poaps';
+import {
+  AuthenticationProviderHttp,
+  PoapCompass,
+  PoapTokenApi,
+} from '@poap-xyz/providers';
 
-  const client = new PoapsClient(new PoapCompass('you_api_key'));
-
+// Create a new instance of PoapsClient
+const client = new PoapsClient(
+  new PoapCompass({
+    apiKey: 'YOUR_COMPASS_API_KEY',
+  }),
+  new PoapTokenApi({
+    apiKey: 'YOUR_POAP_TOKEN_API_KEY',
+    authenticationProvider: new AuthenticationProviderHttp(
+      'YOUR_CLIENT_ID',
+      'YOUR_CLIENT_SECRET',
+    ),
+  }),
+);
 ```
@@ -41,14 +61,26 @@
 
-For more detailed documentation, please visit [this link](https://documentation.poap.tech/docs).
+Detailed documentation for each class, method, and type exported by this package can be found in the [PoapsClient Documentation](#poapsclient-documentation-section).
 
 ## Examples
 
-For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples).
+For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples) directory in the GitHub repository.
 
 ## Contributing
 
-We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines.
+We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines on how to get involved.
 
 ## License
 
-@poap-xyz/drops is released under the [MIT License](https://opensource.org/licenses/MIT).
+@poap-xyz/poaps is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+## Exports
+
+- [`PoapsClient`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/PoapsClient.md)
+- [`POAP`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/POAP.md)
+- [`POAPReservation`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/POAPReservation.md)
+- [`FetchPoapsInput`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/inputs.md/FetchPoapsInput)
+- [`PoapMintStatus`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/responses.md/PoapMintStatus)
+- [`PoapsSortFields`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/inputs.md/PoapsSortFields)
+- [`CodeAlreadyMintedError`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/errors.md/CodeAlreadyMintedError)
+- [`CodeExpiredError`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/errors.md/CodeExpiredError)
+- [`FinishedWithError`](https://github.com/poap-xyz/poap.js/tree/main/packages/poaps/docs/errors.md/FinishedWithError)

No alert changes

Improved metrics

Total package byte prevSize

183369

increased by15.61%

Number of package files

59

increased by11.32%

Number of lines in readme file

83

increased by62.75%

No dependency changes