Skip to content

Commit

Permalink
Merge pull request #1 from Yamaha32088/Yamaha32088-patch-1
Browse files Browse the repository at this point in the history
fix markdown headings
  • Loading branch information
Yamaha32088 authored Oct 17, 2017
2 parents 8ad52ce + b8a66f5 commit 11dca33
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
emit
====

#CFML Event Emitter
# CFML Event Emitter

The primary goal of this project is to be similar to the eventemitter in node.js, although this project might deviate
in some ways from its api. It also seeks to provide an easy way to create async code in CFML. Any event listener can be created as async.
Expand All @@ -11,7 +11,7 @@ in some ways from its api. It also seeks to provide an easy way to create async
I aim to support Railo 4+ first, and ACF 10+ secondarily. ACF 10 is the first version with anonymous functions and closures that this project depends heavily on.
I am not interested in tag based pull requests for this project.

##What is this?
## What is this?

This project has two primary goals:

Expand All @@ -22,9 +22,9 @@ You can think of it as a lightweight message queue or pub/sub framework.

See [Use Cases](useCases.md) for more information.

##[Use Cases](useCases.md)
## [Use Cases](useCases.md)

##Quick Start Guide:
## Quick Start Guide:

emit.cfc in the lib folder is all you need. Put it anywhere you want. Create it as a singleton in your application (use your dependency injection framework of choice if you want).
Or, if you want a separate event emitter for each service, extend emit.
Expand All @@ -51,7 +51,7 @@ Note: Event names are case sensitive by default. You can call `setCaseSensitive

Most functions return an instance of the object so that they can be chained.

##API:
## API:

```addEventListener (required string eventName, required any listener, boolean async = false, numeric timesToListen = -1)```

Expand Down Expand Up @@ -171,12 +171,12 @@ By default, emit treats event names as case sensitive. This method returns true
see isCaseSensitiveEventName().


##Tests
## Tests

Download and provide a mapping to testbox in /tests/Application.cfc, then run tests/index.cfm?opt_run=true


##License
## License

_Apache 2.0_

Expand Down

0 comments on commit 11dca33

Please sign in to comment.