len0rd/Concord
1
0
Fork 0
mirror of https://github.com/Keyslam-Group/Concord.git synced 2025-09-01 20:03:55 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Justin van der Leij 2018-04-07 18:40:57 +02:00 • committed by GitHub
parent 5b2875de4c
commit af16e5a2d9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -8,20 +8,11 @@ Documentation for Concord can be found in the [Wiki tab](https://github.com/Tjak
## Installation
Download the repository and drop it in your project, then simply require it as:
```lua
local Concord = require(PathToConcord).init({
local Concord = require(PathToConcord).init()
})
You will only need to call .init once when you first require it.
```
## Configuration
Concord has a initialization function which takes a table of boolean parameters:
| Name | Default | Meaning |
| --- | --- | --- |
| useEvents | false | Lets Concord overwrite love.run and automatically propagate events. |
You will only need to call .init once.
## Modules
Below is a list of modules.
More information about what each done can be found in the Wiki