Skip to content

Commit

Permalink
feat(README): Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jubnzv committed Oct 9, 2024
1 parent e79179e commit 85b90ec
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ A plugin for the [Blueprint Framework](https://github.com/ton-org/blueprint/) th

## Getting Started

Add this plugin to the `package.json` of your Blueprint project by running:
1. [Install Soufflé](https://souffle-lang.github.io/install) to use all detectors provided by Misti.

2. Add this plugin as a dependency of your Blueprint project:
```bash
yarn add @tact-lang/compiler
yarn add @nowarp/blueprint-misti
```

Then, add this configuration to `blueprint.config.ts`:
3. Add this configuration to `blueprint.config.ts`:
```ts
import { MistiPlugin } from '@nowarp/blueprint-misti';
export const config = {
Expand All @@ -20,12 +22,19 @@ export const config = {
};
```

Now, try to run Misti:
## Usage

Run the following command:
```bash
yarn blueprint misti ./path/to/tact.config.json
yarn blueprint misti
```

It will run the analysis of the available project, if there is one, or show an interactive window to select a project:

![img](./img/select-project.png)

See the [documentation](https://nowarp.io/tools/misti/) for the available configuration options.

## Resources
* [Misti: GitHub](https://github.com/nowarp/misti)
* [Misti: Documentation](https://nowarp.github.io/tools/misti/)
* [Blueprint: GitHub](https://github.com/ton-org/blueprint)
* [Misti Documentation: Using with Blueprint](https://nowarp.io/tools/misti/docs/tutorial/blueprint)
Binary file added img/select-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 85b90ec

Please sign in to comment.