Skip to content

Commit

Permalink
readme: added info
Browse files Browse the repository at this point in the history
  • Loading branch information
olliethedev committed Oct 27, 2023
1 parent 027512c commit dd0e9c3
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 14 deletions.
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.1.17",
"version": "1.1.18",
"private": true,
"workspaces": [
"./packages/*"
Expand Down
2 changes: 1 addition & 1 deletion packages/amplify-graphql-amplifiers-core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@amplifiers/amplify-graphql-amplifiers-core",
"version": "1.1.17",
"version": "1.1.18",
"description": "Amplify GraphQL @createModel transformer. This directive is intended to be used for creating a new model once a Cognito Event is fired.",
"keywords": [
"aws",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@amplifiers/amplify-graphql-create-model-transformer",
"version": "1.1.17",
"version": "1.1.18",
"description": "Amplify GraphQL @createModel transformer. This directive is intended to be used for creating a new model once a Cognito Event is fired.",
"keywords": [
"aws",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@amplifiers/amplify-graphql-process-image-transformer",
"version": "1.1.17",
"version": "1.1.18",
"description": "This directive allows you to process images.",
"keywords": [
"aws",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@amplifiers/amplify-graphql-send-email-transformer",
"version": "1.1.17",
"version": "1.1.18",
"description": "Amplify GraphQL @sendEmail transformer.",
"keywords": [
"aws",
Expand Down
47 changes: 46 additions & 1 deletion packages/amplify-util-blog/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,46 @@
wip
# Amplify Util Blog

Amplify Util Blog is a utility plugin for the Amplify CLI that helps you add blog functionality to your Amplify project. It provides commands to add and remove blog related resources, and it also updates your GraphQL schema, parameters, transformer configuration, and UI elements to support blog features.

## Features

- Adds Post and Tag models to your GraphQL schema.
- Adds blog related UI components to your project.
- Updates parameters configuration with Typesense related parameters to enable search.
- Updates transformer configuration to include `amplify-graphql-typesense-transformer` to enable search.
- Supports only JavaScript/TypeScript React projects.

## Commands

- `version`: Displays the version of the plugin.
- `help`: Provides help information for the plugin.
- `add`: Adds blog related resources to your project.
- `remove`: Removes blog related resources from your project.


## Installation

To use this plugin, you need to install it globally:
```bash
npm install -g @amplifiers/amplify-util-blog
```

Then, you can use the `amplify plugin add` command to add it to your Amplify CLI:
```bash
amplify plugin add /usr/local/lib/node_modules/@amplifiers/amplify-util-blog
```

Follow the prompts to add the `amplify-util-blog` plugin.

## Usage

To add blog functionality to your project, run:
```bash
amplify amplify-util-blog add
```

To remove blog functionality from your project, run:
```bash
amplify amplify-util-blog remove
```

2 changes: 1 addition & 1 deletion packages/amplify-util-blog/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@amplifiers/amplify-util-blog",
"version": "1.1.17",
"version": "1.1.18",
"description": "",
"main": "index.js",
"files": [
Expand Down

0 comments on commit dd0e9c3

Please sign in to comment.