README.md in talkie-0.2.0 vs README.md in talkie-0.3.0
- old
+ new
@@ -9,10 +9,11 @@
- [Talkie](#talkie)
- [Installation](#installation)
- [Usage](#usage)
- [Customization](#customization)
- [Styles](#styles)
+ - [Enabling mentions](#enabling-mentions)
- [Development](#development)
- [Contributing](#contributing)
- [License](#license)
- [Code of Conduct](#code-of-conduct)
@@ -101,9 +102,33 @@
```css
@import "my_variables_to_override";
@import "talkie/application";
```
+
+#### Enabling mentions
+
+Talkie comes with a handy feature that you can toggle in order to
+enable/disable user mentions.
+
+To enable it, just go to you `talkie.rb` initializer file and uncomment
+or add:
+
+```ruby
+config.enable_mentions = true
+```
+
+For customization, check the
+[template](lib/generators/talkie/templates/talkie.rb), you can basically
+override anything to fulfill your needs.
+
+When enabling this module, you need to setup your mailer configuration,
+as with each mentions the commenter subscribes to the comment and
+receives an email, just be aware of that.
+
+If you have a hard time understanding this, you can check the [dummy
+application](spec/dummy) I use for testing or contact
+[me](https://twitter.com/kurenn)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests.