Skip to content

Commit

Permalink
Update readme and add changeset
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelreichor committed Nov 16, 2024
1 parent f265290 commit d6620b3
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 17 deletions.
7 changes: 7 additions & 0 deletions .changeset/healthy-toes-watch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'js-craftcms-api': patch
---

Add support for level, sectionId and type for entry queries.
Make types of builder methods more dry.
Update Readme.
39 changes: 22 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,47 @@
</a>
<h1 align="center">js-craftcms-api</h1>
<p align="center">
A short description what that npm package does.
Bring the Craft CMS Querybuilder to your favorite JS Framework.
</p>
<br />
</div>

<p align="center">
<a href="https://npmjs.com/package/js-craftcms-api">
<img src="https://img.shields.io/npm/v/js-craftcms-api/latest.svg?style=flat-square" alt="Npm Template" />
<img src="https://img.shields.io/npm/v/js-craftcms-api?color=blue" alt="JS Craft CMS API latest version" />
</a>
<a href="https://npmjs.com/package/js-craftcms-api" rel="nofollow">
<img src="https://img.shields.io/npm/dt/js-craftcms-api.svg?style=flat-square" alt="npm">
<img src="https://img.shields.io/npm/d18m/js-craftcms-api?color=blue" alt="JS Craft CMS API downloads">
</a>
<a href="https://npmjs.com/package/js-craftcms-api" rel="nofollow">
<img src="https://img.shields.io/github/license/samuelreichor/js-craftcms-api?color=blue" alt="JS Craft CMS API license">
</a>
</p>

> [!WARNING]
> This npm package is still in production and important features may change.
## Installation
## Features

Install `js-craftcms-api`
- Query addresses, assets, entries and users.
- Easily add preview mode to your headless setup.
- Built with typescript in mind.
- You can easily build your own custom wrapper with that core logic.

```bash
npm install js-craftcms-api
# yarn add js-craftcms-api
```
## Requirements

## Further Resources
This plugin requires the [Craft Query API](https://github.com/samuelreichor/craft-query-api) installed on your Craft CMS instance.

- [Craft CMS Plugin](https://github.com/samuelreichor/craft-query-api)
- [Vue Craft](https://github.com/samuelreichor/vue-craft-sdk)
- [Nuxt Craft](https://github.com/samuelreichor/nuxt-craft)
## Documentation

## Support
Visit the [JS Craft CMS API](https://samuelreichor.at/libraries/js-craftcms-api) for all documentation, guides and developer resources.

- Bugs or Feature Requests? [Submit an issue](/../../issues/new).
## Further Resources

- [Craft Query API](/libraries/craft-query-api): A Craft CMS Plugin, that powers this stuff.
- [Vue Craft CMS](/libraries/vue-craftcms): A package to use the query builder in Vue.
- [Nuxt Craft CMS](/libraries/nuxt-craftcms): A package to use the query builder in Nuxt.

## Contributing
## Support

Contributions are welcome! <3
If you encounter bugs or have feature requests, [please submit an issue](/../../issues/new). Your feedback helps improve the library!

0 comments on commit d6620b3

Please sign in to comment.