README.md in carte-server-0.0.3 vs README.md in carte-server-0.0.4

- old
+ new

@@ -1,31 +1,38 @@ # Carte -TODO: Write a gem description +[![npm version](https://badge.fury.io/js/carte-client.svg)](http://badge.fury.io/js/carte-client) +[![gem Version](https://badge.fury.io/rb/carte-server.svg)](http://badge.fury.io/rb/carte-server) -## Installation +Something like dictionary, wiki, or information card. -Add this line to your application's Gemfile: +## Screenshot -```ruby -gem 'carte' -``` +![](screenshot.png) -And then execute: +## Features - $ bundle +* Manage your data fragments with cards +* Create, edit and search cards quickly +* View your card with the cards around it (like paper dictionary) +* No user concept, super simple system like wiki -Or install it yourself as: +You can try carte on [sandbox](http://carte-sandbox.herokuapp.com/#/). +Japanese introduction is [here](http://tily.tumblr.com/post/117678137942/carte). - $ gem install carte +## Components -## Usage +* [carte-server](https://rubygems.org/gems/carte-server) +* [carte-client](https://www.npmjs.com/package/carte-client) -TODO: Write usage instructions here +## Deploy -## Contributing +[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/tily/carte-sandbox) -1. Fork it ( https://github.com/[my-github-username]/carte/fork ) -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create a new Pull Request +Deploy your carte with the button above. After deployment, you may want to customize your carte. + +``` +## change title and description +$ vi config.json +## replace brand icon +$ cp ~/Desktop/icon.png public/images/icon.png +```