From b8a66f583a19641f225b961a15236e2912d62a7f Mon Sep 17 00:00:00 2001 From: Brandon Brown Date: Tue, 17 Oct 2017 09:00:50 -0500 Subject: [PATCH] fix markdown headings --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f673ed3..0689656 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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: @@ -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. @@ -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)``` @@ -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_