Document events in README

pull/11892/head
Javier Torres 8 years ago
parent 3c1193fce1
commit fc5c04c97e

@ -91,6 +91,9 @@ Note: YARD support for ERB files is quite limited, and ERBs documentation is sti
### Extension points
Most extension points require a registration during intialization. A good
place to put the code it is inside a file in +config/initializers+.
#### Adding links to profile page
See creation at {CartoGearsApi::Pages::SubheaderLink}.
@ -111,3 +114,15 @@ CartoGearsApi::Pages::Subheader.instance.links_generators << lambda do |context|
end
end
```
#### Events
See a list of events at {CartoGearsApi::Events::BaseEvent} and how to subscribe to them with
{CartoGearsApi::Events::EventManager}.
Example:
```ruby
CartoGearsApi::Events::EventManager.instance.subscribe(CartoGearsApi::Events::UserCreationEvent) do |event|
puts "Welcome #{event.user.username}"
end
```

Loading…
Cancel
Save