From 2236f0c3c644f079cf484b12c045f61c47ac8e63 Mon Sep 17 00:00:00 2001 From: Norman Fomferra Date: Sun, 12 Nov 2023 21:48:30 +0100 Subject: [PATCH] updated doc --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5728811..68aa77d 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ ExtendIt.js has been designed to efficiently work with reactive [hooks](). However, the library can be used without React too. It's only a peer dependency. -### Installation +# Installation ```bash npm install @forman2/extendit @@ -34,7 +34,7 @@ or yarn add @forman2/extendit ``` -### Getting Started +# Getting Started Any extension must be defined by its [_extension manifest_](https://forman.github.io/extendit/interfaces/core.ExtensionManifest.html), @@ -301,7 +301,7 @@ export default function CommandButton({ command }: CommandButtonProps) { } ``` -### Acknowledgements +# Acknowledgements ExtendIt.js currently uses the awesome libraries @@ -309,7 +309,9 @@ ExtendIt.js currently uses the awesome libraries * [memoize-one](https://github.com/alexreardon/memoize-one) for implementing state selector functions * [zustand](https://github.com/pmndrs/zustand) for state management -### Development +# Development + +## Source Code Get sources and install dependencies first: @@ -319,6 +321,8 @@ $ cd extendit $ npm install ``` +## Scripts + Now the following scripts are available that can be started with `npm run`: * `dev` - run the UI demo in development mode @@ -328,7 +332,7 @@ Now the following scripts are available that can be started with `npm run`: * `coverage` - generate project coverage report in `./coverage` * `typedoc` - generate project API docs in `./docs/api` -### Configuration +## Configuration You can use `.env` files, e.g., `.env.local` to configure development options: @@ -343,7 +347,7 @@ NODE_ENV=development VITE_LOG_LEVEL=ALL ``` -### Coding style +## Coding style Most of the code is formatted to default settings of [prettier](https://prettier.io/), see its [configuration](./.prettierrc.json). @@ -361,3 +365,10 @@ stick to the following order: If we also have resource dependencies (`*.css`, `*.json`, `*.svg`, ...), we first import TypeScript source dependencies, then separated by a newline, insert resource dependencies in the same order as source dependencies. + +# License + +Copyright © 2023 Norman Fomferra + +Permissions are hereby granted under the terms of the MIT License: +https://opensource.org/licenses/MIT.