-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update README add badges, more information
- Loading branch information
1 parent
d4c205e
commit b9f2a19
Showing
1 changed file
with
22 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,22 @@ | ||
# sidescroller-framework | ||
A framework for CraftStudio to make creating 2D games simpler and easier | ||
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs) | ||
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](#contribute) | ||
[![GitHub Release](https://img.shields.io/github/release/mitchwadair/sidescroller-framework.svg)]() | ||
[![GitHub Downloads](https://img.shields.io/github/downloads/mitchwadair/sidescroller-framework/total.svg)]() | ||
|
||
# SFramework | ||
Welcome to SFramework! | ||
|
||
## Overview | ||
SFramework is a framework for [CraftStudio](https://sparklinlabs.itch.io/craftstudio) to facilitate easier development of 2D games. | ||
|
||
The framework is designed with CraftStudio's current APIs in mind. For this reason, you'll notice similar function/behavior definitions for various components. | ||
|
||
## Learn | ||
API documentation and tutorials can be found in the [doc](https://github.com/mitchwadair/sidescroller-framework/tree/master/doc) folder of this repository. | ||
|
||
If there are any questions or need help with something, feel free to [open an issue](https://github.com/mitchwadair/sidescroller-framework/issues) and tag it with 'question' or 'help wanted'. | ||
|
||
## Contribute | ||
I welcome contributions to this project! | ||
|
||
It is not very intuitive to use CraftStudio with source control, so a tutorial on how you can make contributions can be found LINK_TODO |