Skip to content

Commit

Permalink
feat(docs): Update getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
jubnzv committed Nov 3, 2024
1 parent 5a90730 commit 70cc1f6
Showing 1 changed file with 9 additions and 14 deletions.
23 changes: 9 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,15 @@ sidebar_position: 1

Misti is a static analysis tool designed for smart contracts on the [TON blockchain](https://ton.org/).

**Language Support:**
- [Tact](https://tact-lang.org/) 1.5 is supported.
- Support for [FunC](https://docs.ton.org/develop/func/overview) [is planned](https://github.com/nowarp/misti/issues/56).

## Use Cases

Misti is designed to detect issues in smart contracts efficiently, making it ideal for integration into development tools and CI/CD pipelines. By incorporating Misti, you can:

* **Detect Vulnerabilities:** Identify and fix potential security flaws early in the development cycle.
* **Improve Code Quality:** Maintain high standards by catching bugs and enforcing best practices automatically.
* **Streamline Development:** Integrate Misti into your CI/CD pipeline to ensure continuous code quality checks.
* **Custom Detectors:** Create custom detectors to solve specific problems in your code or to provide a thorough security review if you are an auditor.

Go ahead and read more about the tool, including its design, to fully leverage its capabilities and integrate it effectively into your workflow.
## Language Support
- [Tact](https://tact-lang.org/) is supported
- [FunC](https://docs.ton.org/develop/func/overview) support is [planned](https://github.com/nowarp/misti/issues/56) by the end of the year

## Features
- **Code Analysis**: Identify and fix potential [security flaws and code problems](https://nowarp.io/tools/misti/docs/detectors) early in the development cycle.
- **CI/CD Integration**:
[Integrate](https://nowarp.io/tools/misti/docs/tutorial/ci-cd) Misti into your CI/CD pipeline to ensure continuous code quality checks.
- **Custom Detectors**: Create [custom detectors](https://nowarp.io/tools/misti/docs/hacking/custom-detector) to solve specific problems in your code or to provide a thorough security review if you are an auditor.

## Name Origin
The name "Misti" comes from the Misti volcano in Peru. It was chosen because it's catchy and easy to remember.
Expand Down

0 comments on commit 70cc1f6

Please sign in to comment.