Skip to content

Commit

Permalink
update README add badges, more information
Browse files Browse the repository at this point in the history
  • Loading branch information
mitchwadair authored Feb 14, 2020
1 parent d4c205e commit b9f2a19
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
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

0 comments on commit b9f2a19

Please sign in to comment.