Skip to content

Commit 6f72adf

Browse files
committed
♻️ Updated badges and fixed some typos in the README
1 parent 8b41d43 commit 6f72adf

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# nuxtjs-ghost
22

3+
![build](https://img.shields.io/github/workflow/status/ditschedev/nuxtjs-ghost/ci)
34
![npm version](https://badge.fury.io/js/nuxtjs-ghost.svg)
4-
![npm downloads](https://img.shields.io/npm/dw/nuxtjs-ghost)
5+
![npm downloads](https://img.shields.io/npm/dt/nuxtjs-ghost)
6+
![dependencies](https://david-dm.org/ditschedev/nuxtjs-ghost.svg)
57
![License](https://img.shields.io/github/license/ditschedev/nuxtjs-ghost)
68

79
> NuxtJS module to easily interact with the 👻 Ghost API
@@ -35,7 +37,7 @@ After that you need to register the plugin, that NuxtJS can pick it up. To do th
3537
```
3638

3739
## Configuration
38-
The plugin needs an api key of your site and its endpoint url. Optionally you can pass the version of the Ghost API you want to use. Typically the endpoint for your api is your sites hostname.
40+
The plugin needs an API key of your site and its endpoint URL. Optionally you can pass the version of the Ghost API you want to use. Typically the endpoint for your API is your sites hostname.
3941

4042
To set these values you have two options:
4143
1. Use the default module options
@@ -59,7 +61,7 @@ When registering the module, don't register it as a string, but an array. The sy
5961
```
6062

6163
#### Global Configuration
62-
To set up global configuration, add the following object to your `export` of `nuxt.config.js`:
64+
To set up a global configuration, add the following object to your `export` of `nuxt.config.js`:
6365
```js
6466
ghost: {
6567
url: 'YOUR_API_ENDPOINT',
@@ -70,8 +72,8 @@ ghost: {
7072
#### Environment Variables
7173
If you don't want sensitive data in your code, or got multiple environments, you can use environment variables to configure this plugin.
7274

73-
`GHOST_API_KEY`: Sets the api key.
74-
`GHOST_API_URL`: Sets the api endpoint.
75+
`GHOST_API_KEY`: Sets the API key.
76+
`GHOST_API_URL`: Sets the API endpoint.
7577

7678
## Usage
7779
The usage is pretty straight forward. This package is just a wrapper for the official [JavaScript Content API](https://ghost.org/docs/api/v3/content/). Please check out their documentation to learn about [filtering](https://ghost.org/docs/api/v3/content/#parameters) or [pagination](https://ghost.org/docs/api/v3/content/#pagination). The `filter` parameter of the following methods is an `object` representation of the available query filters.

0 commit comments

Comments
 (0)