Skip to content

Commit

Permalink
update Doc README for new contents
Browse files Browse the repository at this point in the history
  • Loading branch information
mitchwadair authored Feb 14, 2020
1 parent ef5ee65 commit d4c205e
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# SFramework Documentation
Welcome to SFramework's API documentation!

Here, you can find all the information you need on how to use SFramework as well as some guides on the more nuanced parts of the framework. If any clarification is needed, please open an [issue](https://github.com/mitchwadair/sidescroller-framework/issues) and the documentation will be updated ASAP.

# Contents
- [CraftStudio Extensions](https://github.com/mitchwadair/sidescroller-framework/blob/master/doc/CraftStudio%20Extensions.md)
- [API](https://github.com/mitchwadair/sidescroller-framework/tree/master/doc/API)
- [CraftStudio Extensions](https://github.com/mitchwadair/sidescroller-framework/blob/master/doc/API/CraftStudio%20Extensions.md)
- [Components](https://github.com/mitchwadair/sidescroller-framework/tree/master/doc/API/Components)
- [SpriteRenderer](https://github.com/mitchwadair/sidescroller-framework/blob/master/doc/API/Components/SpriteRenderer.md)

0 comments on commit d4c205e

Please sign in to comment.