From 16edf70c75df127828d04d5233a1d926ec71fd4b Mon Sep 17 00:00:00 2001 From: Anthony Tarlao Date: Wed, 26 Jul 2023 17:32:36 +0200 Subject: [PATCH] Update README --- README.md | 24 +++++------------------- 1 file changed, 5 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index f110d1b3..5cf2d6b2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -**TODO:** Update the badge URLs for the new module's repo. -
ApostropheCMS logo @@ -14,43 +12,31 @@ - +

-This module template serves as a starting point for new official Apostrophe modules. This is where you would describe what the purpose of the module is. +This module enables import and export pages and pieces with or without their relationships and associated files and images within A3 projects. ## Installation To install the module, use the command line to run this command in an Apostrophe project's root directory: ``` -npm install @apostrophecms/module-template +npm install @apostrophecms/import-export ``` ## Usage -Configure the _______ module in the `app.js` file: +Configure the module in the `app.js` file: ```javascript require('apostrophe')({ shortName: 'my-project', modules: { - '@apostrophecms/module-template': {} + '@apostrophecms/import-export': {} } }); ``` - -### Additional usage sections - -### Pre-release checks - -- [ ] If the module does not include CSS, remove the Stylelint config file and dependency `npm remove --save-dev stylelint stylelint-config-apostrophe` -- [ ] If the module does not include any Vue.js components, remove - - [ ] set in `package.json`, `"eslint": "eslint .",` - - [ ] remove Vue.js packages `npm remove --save-dev eslint-plugin-vue vue-eslint-parser` -- [ ] If the module does not contains any tests, remove mocha `npm remove --save-dev mocha` -- [ ] If this file contains images, please use public static endpoint to load the images. -- [ ] If any template includes a script with inline code, include the `nonce` attribute set like this: `