Skip to content

Commit

Permalink
docs: rename to @publicodes/tools
Browse files Browse the repository at this point in the history
  • Loading branch information
EmileRolley authored Nov 9, 2023
1 parent 88695c4 commit a27f229
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<div align="center">
<h3 align="center">
<big><code>@incubateur-ademe/publicodes-tools</code></big>
<big><code>@publicodes/tools</code></big>
</h3>
<p align="center">
<a href="https://github.com/incubateur-ademe/publicodes-tools/issues">Report Bug</a>
<a href="https://github.com/publicodes/tools/issues">Report Bug</a>
<a href="https://incubateur-ademe.github.io/publicodes-tools/">API docs</a>
<a href="https://publicodes.github.io/tools/">API docs</a>
<a href="https://github.com/incubateur-ademe/publicodes-tools/blob/master/CONTRIBUTING.md">Contribute</a>
<a href="https://github.com/publicodes/tools/blob/master/CONTRIBUTING.md">Contribute</a>
<a href="https://publi.codes">Publicodes</a>
</p>
Expand All @@ -23,16 +23,16 @@ by the nosgestesclimat.fr team.</i> :warning:

## Features

- 🏗️ Compiles your set of Publicodes files into a standalone JSON file - [[doc](https://incubateur-ademe.github.io/publicodes-tools/modules/compilation.html#md:compile-a-model-from-a-source)]
- 📦 Resolves import from external Publicodes models, from source and from published [NPM packages](https://www.npmjs.com/package/futureco-data) - [[doc](https://incubateur-ademe.github.io/publicodes-tools/modules/compilation.html#md:import-rules-from-a-npm-package)]
- 🪶 Pre-computes your model at compile time and reduces [the number of rules by ~65%](https://github.com/incubateur-ademe/nosgestesclimat/pull/1697) - [[doc](https://incubateur-ademe.github.io/publicodes-tools/modules/optims.html)]
- 🏗️ Compiles your set of Publicodes files into a standalone JSON file - [[doc](https://publicodes.github.io/tools/modules/compilation.html#md:compile-a-model-from-a-source)]
- 📦 Resolves import from external Publicodes models, from source and from published [NPM packages](https://www.npmjs.com/package/futureco-data) - [[doc](https://publicodes.github.io/tools/modules/compilation.html#md:import-rules-from-a-npm-package)]
- 🪶 Pre-computes your model at compile time and reduces [the number of rules by ~65%](https://github.com/incubateur-ademe/nosgestesclimat/pull/1697) - [[doc](https://publicodes.github.io/tools/modules/optims.html)]

## Installation

```
npm install --dev-dependency @incubateur-ademe/publicodes-tools
npm install --dev-dependency @publicodes/tools
yarn add -D @incubateur-ademe/publicodes-tools
yarn add -D @publicodes/tools
```

## Usage in local
Expand All @@ -41,7 +41,7 @@ When developing in local:

1. you can link the local package with `yarn link`,
2. launch the compilation in watch mode with `yarn watch`,
3. and use it in your project with `yarn link @incubateur-ademe/publicodes-tools`.
3. and use it in your project with `yarn link @publicodes/tools`.

[ci-link]: https://img.shields.io/github/actions/workflow/status/incubateur-ademe/publicodes-tools/build.yml?logo=github&logoColor=white&label=build%20%26%20test
[npm-link]: https://img.shields.io/npm/v/%40incubateur-ademe%2Fpublicodes-tools?logo=npm&logoColor=white&color=%23185dae
[ci-link]: https://img.shields.io/github/actions/workflow/status/publicodes/tools/build.yml?logo=github&logoColor=white&label=build%20%26%20test
[npm-link]: https://img.shields.io/npm/v/%40publicodes%2Ftools?logo=npm&logoColor=white&color=%23185dae

0 comments on commit a27f229

Please sign in to comment.