diff --git a/README.md b/README.md index 75e95e2..38a7493 100644 --- a/README.md +++ b/README.md @@ -25,24 +25,3 @@ commands in the cloned repository: git submodule init git submodule update - -## Modules: - -### Spelling - -Will attempt to correct a users' spelling by using the levenshtein distance -algorithm. One corrects the spelling of their previous message by simply posting -a message with their correction and an asterisk: - - > user: I am a tutrle. - > user: *turtle - user meant: I am a turtle. - -The regular expression for this module also accepts two asterisks at the -beginning of the correction, or at the end; it also accepts several words as the -correction and deals with these fairly intelligently. Users may also attempt -to correct another users like so: - - > userone: I am a tutrle. - > usertwo: userone: *turtle - > usertwo thinks userone meant: I am a turtle. diff --git a/modules/spelling/README.md b/modules/spelling/README.md new file mode 100644 index 0000000..73a2195 --- /dev/null +++ b/modules/spelling/README.md @@ -0,0 +1,22 @@ +## Spelling + +Fix your spelling. + +### Description + +Will attempt to correct a users' spelling by using the levenshtein distance +algorithm. One corrects the spelling of their previous message by simply posting +a message with their correction and an asterisk: + + > user: I am a tutrle. + > user: *turtle + user meant: I am a turtle. + +The regular expression for this module also accepts two asterisks at the +beginning of the correction, or at the end; it also accepts several words as the +correction and deals with these fairly intelligently. Users may also attempt +to correct another users like so: + + > userone: I am a tutrle. + > usertwo: userone: *turtle + > usertwo thinks userone meant: I am a turtle.