update readme
This commit is contained in:
parent
8788d07d6d
commit
525f5d95ae
37
README.md
37
README.md
|
@ -2,4 +2,39 @@
|
|||
|
||||
This addon uses the `@tryghost/content-api` and creates astro friendly functions to interface between ghost and astro.
|
||||
|
||||
## Work In Progress README (*More Information will be provided as time goes on...*)
|
||||
This package contains a independent copy of the tryghost content-api.js that is used to establish the connection so this package dose not depend on `@tryghost/content-api` package.
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
npm install @adammatthiesen/astro-ghostcms
|
||||
```
|
||||
|
||||
Must create `.env` with the following:
|
||||
|
||||
```env
|
||||
CONTENT_API_KEY=
|
||||
CONTENT_API_URL=
|
||||
```
|
||||
|
||||
Astro minimum Version: **Astro v4.0**
|
||||
|
||||
Dependencies:
|
||||
- **Axios v1.0** *Will be auto installed*
|
||||
- **Typescript v5.3.3** *Will be auto installed*
|
||||
|
||||
## Work In Progress README (*More Information will be provided as time goes on...*)
|
||||
|
||||
Basic Usage:
|
||||
|
||||
- getGhostPosts() - Get list of posts
|
||||
- getGhostRecentPosts(setLimit?) - Get Recent Posts (setLimit={6})
|
||||
- getGhostFeaturedPosts(setLimit?) - Get Featured Posts (setLimit={1})
|
||||
- getGhostPostbySlug(slug) - Get Post by Slug
|
||||
- getGhostPostsbyTag(slug) - Get Posts list by Tag slug
|
||||
- getGhostTags() - Get list of tags
|
||||
- getGhostTagbySlug(slug) - Get Tag by slug
|
||||
- getGhostAuthors() - Get list of Authors
|
||||
- getGhostPages() - Get list of Pages
|
||||
- getGhostPage(slug) - Get page by slug
|
||||
- getGhostSettings() - Get Settings for GhostCMS
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "@adammatthiesen/astro-ghostcms",
|
||||
"description": "Astro GhostCMS integration to allow easier importing of GhostCMS Content",
|
||||
"version": "0.0.1-beta.0",
|
||||
"version": "0.0.1-beta.2",
|
||||
"author": "Adam Matthiesen <adam@matthiesen.xyz>",
|
||||
"type": "module",
|
||||
"license": "MIT",
|
||||
|
|
Loading…
Reference in New Issue