summaryrefslogtreecommitdiffhomepage
path: root/README.mdown
diff options
context:
space:
mode:
authorrealtradam <[email protected]>2021-07-09 03:50:04 -0400
committerrealtradam <[email protected]>2021-07-09 03:50:04 -0400
commita8c84b1bd0ee1fef6891032f9d3d4b8a8b5fc9f2 (patch)
tree4fee86ae8484f80f3cc3132efc2329e0164d7cce /README.mdown
parent0fbb48c7b0ef7070664945ef22840b0bfbfe9153 (diff)
downloadFelECS-a8c84b1bd0ee1fef6891032f9d3d4b8a8b5fc9f2.tar.gz
FelECS-a8c84b1bd0ee1fef6891032f9d3d4b8a8b5fc9f2.zip
released as gem
Diffstat (limited to 'README.mdown')
-rw-r--r--README.mdown2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.mdown b/README.mdown
index 3149178..d319066 100644
--- a/README.mdown
+++ b/README.mdown
@@ -99,6 +99,8 @@ If all of this sounds very confusing, don't worry. A video tutorial series is in
# Usage
+To use FelFlame simply install the gem using `gem install felflame` or using bundler `bundle add felflame` and then require it in your project like so: `require 'felflame'`. Working outside of the gem for rendering engines that do not support the usage of gems is planned a planned feature in the works.
+
## Entities
### Creation