Skip to content

Commit

Permalink
docs: update how to add language
Browse files Browse the repository at this point in the history
  • Loading branch information
HyungJu authored Oct 3, 2020
1 parent f04997b commit e5dc938
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,18 @@ For best results, use an integer value of 3, 4, or 5.
## Test
`composer test`

## Adding new language
1. Add wordsets to `src/words/[language code]`.
adjectives.txt and nouns.txt are needed.

2. Create your language class `src/Language/[language code].php`. the class name must be started with Uppercase.

3. Implement the class based on other languages already implemented (korean and english)

4. Register your language in `src/Language/LanguageHelper.php`.

5. (optional) Add test for your language.

## Versioning
We use [SemVer](https://semver.org/) for versioning this project.

Expand Down

0 comments on commit e5dc938

Please # to comment.