Update README.md

main
Jake Dexheimer 8 years ago
parent 026b3443ef
commit 4b986affd7

@ -1,6 +1,43 @@
# Code
## Introduction
### Usage
You know [all](TODO) [of](TODO) [those](TODO) [code](TODO) [screenshots](TODO) you see on Twitter? Although the code's usually impressive, we saw room for improvement in the aesthetic department. Carbon makes it easy to create and share beautiful images of your source code. So what are you waiting for? Go impress all of your followers with your newfound design prowess. 🎨
Visit [dawnlabs.io/carbon](http://dawnlabs.io/carbon) or read [our post](TODO) to learn more about the project.
## Features
* **Import from GitHub gist**. Simply append a GitHub gist id to the url
* **Customization**. Customize things like your image's syntax theme, window style, and more
* **Share quickly**. Save your image or copy a Imgur link to it with one click
## Usage
##### Import
There are a few different ways to import code into Carbon:
- Drag a file onto the editor
- Append a GitHub Gist id to the url
- Paste your code directly!
- Append a GitHub gist id to the url (e.g. `www.dawnlabs.io/carbon/GIST_ID_HERE`)
- Paste your code directly
##### Customization
Once you've got all of your code into Carbon, you can customize your image by changing the syntax theme, background color, window theme, or padding.
##### Export/Sharing
After you've customized your image you can copy an Imgur link to the image, or save it directly.
## Contribute
If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.
If you'd like to make some changes yourself, see the following:
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
2. Build the webpack bundle and start the application: `yarn build && yarn start`
3. Finally, submit a [pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) with your changes!
## Authors
Carbon is a project by <a href="http://dawnlabs.io/"><img width=8% src="https://cloud.githubusercontent.com/assets/10369094/25406306/dacebd4c-29cb-11e7-8e1c-468687cde495.png"></a>
- Mike Fix ([@mfix22](https://github.com/mfix22))
- Brian Dennis ([@briandennis](https://github.com/briandennis))
- Jake Dexheimer ([@jakedex](https://github.com/jakedex))

Loading…
Cancel
Save