Skip to content
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

Merged
merged 7 commits into from
Sep 5, 2022
Merged

Overhaul and improve readability of the readme #36

merged 7 commits into from
Sep 5, 2022

Conversation

johannschopplich
Copy link
Contributor

@johannschopplich johannschopplich commented Jun 21, 2022

What Is This?

This PR enhances the README's readability:

  • Use <details> element to hide responses, which shortens the whole document.
  • Replace axios with ohmyfetch
    • It is pretty outdated and bulky by not using the Fetch standard. ohmyfetch is a thin wrapper around fetch 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.
  • It is time to drop CJS in favor of ESM.
  • Prettier is used to format the JS and JSON snippets.

馃憠 Preview of the improved README

<details> Response Example

馃啑 Response
{
  code: 200,
  result: "Kirby Starterkit",
  status: "ok"
}

Other Notes

This also closes #34.

@johannschopplich johannschopplich changed the title Overhaul the README Overhaul and refactor the README Jun 21, 2022
@johannschopplich johannschopplich changed the title Overhaul and refactor the README Overhaul and improve readability of the readme Jun 21, 2022
@johannschopplich
Copy link
Contributor Author

@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:
Copy link
Member

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)

@distantnative distantnative merged commit 294134e into getkirby:develop Sep 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants