-
-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Overhaul and improve readability of the readme #36
Conversation
@bastianallgeier Any chance reviewing (and eventually merging) this and releasing v1.1.0 soon? 馃檪 |
composer require getkirby/kql | ||
``` | ||
|
||
## Documentation | ||
|
||
### API Endpoint | ||
|
||
KQL adds a new `query` API endpoint to your Kirby API. (i.e. https://yoursite.com/api/query) The endpoint requires authentication: https://getkirby.com/docs/guide/api/authentication | ||
KQL adds a new `query` API endpoint to your Kirby API (i.e. `yoursite.com/api/query`). This endpoint [requires authentication](https://getkirby.com/docs/guide/api/authentication). | ||
|
||
You can switch off authentication in your config at your own risk: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a new feature, but it sounds more like an anti-feature. I think here we should tell the user what the risk actually is.
(@johannschopplich I know you didn't make any changes here, just leaving it as remark)
What Is This?
This PR enhances the README's readability:
<details>
element to hide responses, which shortens the whole document.axios
withohmyfetch
ohmyfetch
is a thin wrapper aroundfetch
and the basis for all requests in Nuxt 3. Thus, not one of the many fetch-wrapping libraries, but a well-tested one. It works in the browser and node.馃憠 Preview of the improved README
<details>
Response Example馃啑 Response
Other Notes
This also closes #34.