Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.34 KB

README.md

File metadata and controls

59 lines (37 loc) · 2.34 KB
Raw

@postiva/client

Easily manage and retrieve content within your applications with @postiva/client, a powerful library that simplifies interactions with the Postiva platform. Keep your content up-to-date and accessible with our simple API.

For detailed API documentation and more examples, visit our official documentation.

npm version GitHub license

Features

  • Effortless Content Management: Seamlessly fetch and manage content within your application.
  • Pagination Support: Handle large datasets effectively with built-in pagination support.
  • REST API Support: Integrate your blog seamlessly into any tech stack with REST API support.
  • TypeScript Support: Enjoy type safety and autocompletion with TypeScript support.
  • Statistics: Get insights into your content's performance and engagement. (views, claps, likes)

Installation

You can install @postiva/client via npm, yarn, or pnpm:

npm install @postiva/client

Usage

To start using @postiva/client in your project, initialize the client by providing your workspace ID and API key:

import { createClient } = from "@postiva/client"

// Initialize Postiva Client
const client = createClient({
  workspaceId: "yourWorkspaceId",
  apiKey: "yourApiKey",
});

Rest API Documentation

The REST API documentation for @postiva/client has been automatically generated by Bruno. Please refer to REST API Documentation for details.

Contributing

Contributions to @postiva/client are welcome! If you have ideas for improvements, found a bug, or want to contribute new features, please check out our contribution guidelines and code of conduct before opening an issue or submitting a pull request.

Contributors

Thank you for your contributions! We appreciate all the contributions from the community.

License

@postiva/client is available under the MIT License. For more details, see the LICENSE file.