Skip to content

📝 Update README #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mirror-kt merged 1 commit into from
Dec 31, 2025
Merged

📝 Update README #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## textlint-plugin-rustdoc

![NPM Version](https://img.shields.io/npm/v/%40mirror-kt%2Ftextlint-plugin-rustdoc)
[![NPM Version](https://img.shields.io/npm/v/%40mirror-kt%2Ftextlint-plugin-rustdoc)](https://www.npmjs.com/package/@mirror-kt/textlint-plugin-rustdoc)

[textlint](https://textlint.org) plugin to support [rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html)
comments.
Expand Down Expand Up @@ -29,4 +29,8 @@ And write the following content in the textlint configuration file (e.x. `.textl
// your rules...
}
}
```
```

### License

This project is licensed under [MIT License](https://opensource.org/license/mit).
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@mirror-kt/textlint-plugin-rustdoc",
"version": "0.1.1",
"description": "",
"description": "textlint plugin to support rustdoc",
"type": "module",
"main": "./dist/index.js",
"files": [
Expand Down