Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
forman committed Nov 12, 2023
1 parent 9713e61 commit 2236f0c
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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),
Expand Down Expand Up @@ -301,15 +301,17 @@ export default function CommandButton({ command }: CommandButtonProps) {
}
```

### Acknowledgements
# Acknowledgements

ExtendIt.js currently uses the awesome libraries

* [Ajv](https://ajv.js.org/) for JSON validation (may be turned into peer dependency later)
* [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:

Expand All @@ -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
Expand All @@ -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:

Expand All @@ -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).
Expand All @@ -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.

0 comments on commit 2236f0c

Please sign in to comment.