Skip to content

Commit

Permalink
chore: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
azu committed Oct 17, 2021
1 parent 49b2226 commit 7d6995b
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @textlint-rule/textlint-rule-no-duplicate-abbr

textlint rule that avoid adding duplicated suffix word for Acronyms and Abbreviations.
[textlint](https://github.com/textlint/textlint) rule that avoid adding duplicated suffix word for Acronyms and Abbreviations.

**OK**:

Expand All @@ -11,13 +11,18 @@ BGP is Border Gateway Protocol.
**NG**:

```
DAO object is Data Access Object
This is BGP protocol
This is BGP protocol.
DAO object is Data Access Object.
これはBGPプロトコルです。
```

You can avoid using "DAO Object" - "Data Access Object Object".

## Supported Languages

- {Acronyms or Abbreviations} + English
- {Acronyms or Abbreviations} + Japanese

## Install

Install with [npm](https://www.npmjs.com/):
Expand Down

0 comments on commit 7d6995b

Please sign in to comment.