diff --git a/README.md b/README.md index a9304fd..934631e 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ ![Build Status](https://github.com/poap-xyz/poap.js/actions/workflows/npm_publish.yml/badge.svg) -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 it. +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 it. ## Table of Contents @@ -85,7 +85,10 @@ Contributions to the POAP Package Library are welcome. To contribute, please fol 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. +Please ensure that your code adheres to the project's code style and passes all tests before +submitting a pull request. + +See [`CONTRIBUTING.md`](../.github/CONTRIBUTING.md) file for guidelines on how to get involved. ## Active contributors diff --git a/docs/README.md b/docs/README.md index a1de4a6..4d152eb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,23 +1,25 @@ # POAP.js Documentation Website -This is a documentation website for POAP.js, a library for integrating with the POAP platform in JavaScript applications. +This is a documentation website for POAP.js, a library for integrating with the POAP 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 yarn: - -### NPM +To get started with this website, you'll need to install its dependencies and start the development +server. You can do this using yarn: ```bash yarn install yarn dev ``` -Once the development server is running, you can view the website in your web browser by navigating to `http://localhost:3000`. +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. +We welcome contributions! Please see the [`CONTRIBUTING.md`](../.github/CONTRIBUTING.md) file for +guidelines on how to get involved. ## License diff --git a/packages/drops/README.md b/packages/drops/README.md index f50fa41..50e96a8 100644 --- a/packages/drops/README.md +++ b/packages/drops/README.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -@poap-xyz/drops is a package to interact with POAP Drops. +`@poap-xyz/drops` is a package to interact with POAP Drops. ## Features @@ -40,16 +40,16 @@ yarn add @poap-xyz/drops @poap-xyz/utils @poap-xyz/providers axios ## Documentation -For more detailed documentation, please visit [this link](https://documentation.poap.tech/docs). +For more detailed documentation, please visit: -## Examples - -For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples). +- [`@poap-xyz/drops` documentation](https://sdk.poap.tech/packages/drops) +- [POAP documentation](https://documentation.poap.tech/docs) ## Contributing -We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines. +We welcome contributions! Please see the [`CONTRIBUTING.md`](../../.github/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/drops` is released under the [MIT License](https://opensource.org/licenses/MIT). diff --git a/packages/frames/README.md b/packages/frames/README.md index 00ccd8c..7914d47 100644 --- a/packages/frames/README.md +++ b/packages/frames/README.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -@poap-xyz/frames is a package to help with the development of Farcaster Frames. +`@poap-xyz/frames` is a package to help with the development of Farcaster Frames. ## Features @@ -44,7 +44,7 @@ return ( ### HTML render -```javascript +```typescript // /api/frame.ts export default async function handler(req: NextApiRequest, res: NextApiResponse) { const frame = new Frame({ ... }); @@ -52,14 +52,18 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse) } ``` -## Examples +## Documentation + +For more detailed documentation, please visit: -For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples). +- [`@poap-xyz/frames` documentation](https://sdk.poap.tech/packages/frames) +- [POAP documentation](https://documentation.poap.tech/docs) ## Contributing -We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines. +We welcome contributions! Please see the [`CONTRIBUTING.md`](../../.github/CONTRIBUTING.md) file for +guidelines on how to get involved. ## License -@poap-xyz/frames is released under the [MIT License](https://opensource.org/licenses/MIT). +`@poap-xyz/frames` is released under the [MIT License](https://opensource.org/licenses/MIT). diff --git a/packages/moments/README.md b/packages/moments/README.md index dfc0895..e60f6d6 100644 --- a/packages/moments/README.md +++ b/packages/moments/README.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -@poap-xyz/moments is a package to interact with POAP Moments. +`@poap-xyz/moments` is a package to interact with POAP Moments. ## Features @@ -26,7 +26,7 @@ yarn add @poap-xyz/moments @poap-xyz/utils @poap-xyz/providers axio ## Usage -```javascript +```typescript import {MomentsClient, CreateMomentInput, Moment} from '@poap-xyz/moments'; import {PoapCompass, PoapMomentsApi, AuthenticationProviderHttp} from '@poap-xyz/providers'; import fs from 'fs'; @@ -75,16 +75,16 @@ Explanations for each step: ## Documentation -For more detailed documentation, please visit [this link](https://documentation.poap.tech/docs). +For more detailed documentation, please visit: -## Examples - -For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples). +- [`@poap-xyz/moments` documentation](https://sdk.poap.tech/packages/moments) +- [POAP documentation](https://documentation.poap.tech/docs) ## Contributing -We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines. +We welcome contributions! Please see the [`CONTRIBUTING.md`](../../.github/CONTRIBUTING.md) file for +guidelines on how to get involved. ## License -@poap-xyz/moments is released under the [MIT License](https://opensource.org/licenses/MIT). +`@poap-xyz/moments` is released under the [MIT License](https://opensource.org/licenses/MIT). diff --git a/packages/poaps/README.md b/packages/poaps/README.md index 9f722a9..67152b5 100644 --- a/packages/poaps/README.md +++ b/packages/poaps/README.md @@ -2,7 +2,9 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -`@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. +`@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 @@ -55,28 +57,16 @@ const client = new PoapsClient( ## Documentation -Detailed documentation for each class, method, and type exported by this package can be found in the [PoapsClient Documentation](#poapsclient-documentation-section). +For more detailed documentation, please visit: -## 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. +- [`@poap-xyz/poaps` documentation](https://sdk.poap.tech/packages/poaps) +- [POAP documentation](https://documentation.poap.tech/docs) ## Contributing -We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines on how to get involved. +We welcome contributions! Please see the [`CONTRIBUTING.md`](../../.github/CONTRIBUTING.md) file for +guidelines on how to get involved. ## License -@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) +`@poap-xyz/poaps` is released under the [MIT License](https://opensource.org/licenses/MIT). diff --git a/packages/providers/README.md b/packages/providers/README.md index 119e0a7..1c12ec2 100644 --- a/packages/providers/README.md +++ b/packages/providers/README.md @@ -2,7 +2,8 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -@poap-xyz/providers is a package to use POAP providers that let you iteract with POAPs APIs. Also you can make your own provider by extending the interfaces. +`@poap-xyz/providers` is a package to use POAP providers that let you iteract with POAPs APIs. Also +you can make your own provider by extending the interfaces. ## Features @@ -25,16 +26,16 @@ yarn add @poap-xyz/providers axios ## Documentation -For more detailed documentation, please visit [this link](https://documentation.poap.tech/docs). +For more detailed documentation, please visit: -## Examples - -For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples). +- [`@poap-xyz/providers` documentation](https://sdk.poap.tech/packages/providers) +- [POAP documentation](https://documentation.poap.tech/docs) ## Contributing -We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines. +We welcome contributions! Please see the [`CONTRIBUTING.md`](../../.github/CONTRIBUTING.md) file for +guidelines on how to get involved. ## License -@poap-xyz/providers is released under the [MIT License](https://opensource.org/licenses/MIT). +`@poap-xyz/providers` is released under the [MIT License](https://opensource.org/licenses/MIT). diff --git a/packages/utils/README.md b/packages/utils/README.md index f1b51d9..d7327b0 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -@poap-xyz/utils is a package that contains auxiliar functions. +`@poap-xyz/utils` is a package that contains auxiliar functions and common types. ## Features @@ -25,16 +25,16 @@ yarn add @poap-xyz/utils ## Documentation -For more detailed documentation, please visit [this link](https://documentation.poap.tech/docs). +For more detailed documentation, please visit: -## Examples - -For example scripts and usage, please check the [examples](https://github.com/poap-xyz/poap.js/tree/main/examples). +- [`@poap-xyz/utils` documentation](https://sdk.poap.tech/packages/utils) +- [POAP documentation](https://documentation.poap.tech/docs) ## Contributing -We welcome contributions! Please see the `CONTRIBUTING.md` file for guidelines. +We welcome contributions! Please see the [`CONTRIBUTING.md`](../../.github/CONTRIBUTING.md) file for +guidelines on how to get involved. ## License -@poap-xyz/utils is released under the [MIT License](https://opensource.org/licenses/MIT). +`@poap-xyz/utils` is released under the [MIT License](https://opensource.org/licenses/MIT).