Skip to content

Commit

Permalink
update readme (#14)
Browse files Browse the repository at this point in the history
add credits and update install guide
  • Loading branch information
notJoon authored Jul 22, 2024
1 parent df1127d commit 6326ef8
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,37 @@ Inspired by Rust's [clippy](https://github.com/rust-lang/rust-clippy), tlin aims

- Support for Go (.go) and Gno (.gno) files
- Ability to add custom lint rules
- Additional code improvement suggestion, such as detecting unnecessary code (🚧 WIP)
- Additional code improvement suggestion, such as detecting unnecessary code
- Auto-fixing for some lint rules (🚧 WIP)

## Installation

- Requirements:
- Go: 1.22 or higher
- latest version of gno

To install tlin CLI, run:
To install tlin CLI, follow these steps:

1. Clone the repository

```bash
git clone https://github.com/gnoswap-labs/tlin
```

2. Move to the cloned directory

```bash
cd tlin
```

3. Install the CLI

```bash
go install ./cmd/tlin
```

that's it! You can now use the `tlin` command in your terminal.

## Usage

```bash
Expand Down Expand Up @@ -108,6 +125,10 @@ By following these steps, you can add new lint rules and ensure they are properl

We welcome all forms of contributions, including bug reports, feature requests, and pull requests. Please feel free to open an issue or submit a pull request.

## Credits

- [@GodDrinkTeJAVA](https://github.com/GodDrinkTeJAVA) - Project name (`tlin`) suggestion

## License

This project is distributed under the MIT License. See `LICENSE` for more information.

0 comments on commit 6326ef8

Please sign in to comment.