README.md in yamg-0.0.5 vs README.md in yamg-0.0.7
- old
+ new
@@ -1,28 +1,91 @@
# YAMG
- _____ _____ _____ ______ _______ _____
- |\ \ / /| ___|\ \ | \/ \ ___|\ \
- | \ \ / / | / /\ \ / /\ \ / /\ \
- | \____\/ / /| | | | / /\ / /\ || | |____|
- \ | / / / | |__| | / /\ \_/ / / /|| | ____
- \|___/ / / | .--. || | \|_|/ / / || | | |
- / / / | | | || | | | || | |_, |
- /____/ / |____| |____||\____\ |____| /|\ ___\___/ /|
- |` | / | | | || | | | | / | | /____ / |
- |_____|/ |____| |____| \|____| |____|/ \|___| | /
- \|____|/
+ _____ _____ _____ ______ _______ _____
+ |\ \ / /| ___|\ \ | \/ \ ___|\ \
+ | \ \ / / | / /\ \ / /\ \ / /\ \
+ | \____\/ / /| | | | / /\ / /\ || | |____|
+ \ | / / / | |__| | / /\ \_/ / / /|| | ____
+ \|___/ / / | .--. || | \|_|/ / / || | | |
+ / / / | | | || | | | || | |_, |
+ /____/ / |____| |____||\____\ |____| /|\ ___\___/ /|
+ |` | / | | | || | | | | / | | /____ / |
+ |_____|/ |____| |____| \|____| |____|/ \|___| | /
+ \|____|/
[](http://badge.fury.io/rb/yamg)
[](https://gemnasium.com/nofxx/yamg)
[](https://travis-ci.org/nofxx/yamg)
-YAMG
+YAMG - Yet Another Media Generator
+
## Install
- gem 'yamg'
+Linux
+ nice-pkg-manager install imagemagick phantomjs ruby
+ gem install yamg
+OSX
+
+ brew install imagemagick phantomjs ruby
+ gem install yamg
+
+
+## Features
+
+* Find best version (size) to use from icons folder.
+* Splash screen/banner generation with gravity.
+* Works with iOS/Android/Other mobile with Phonegap or Cordova.
+
+
## Use
+
+ yamg
+
+A `.yamg.yml` will be created on the folder.
+
+### Icons
+
+Multiple sizes:
+Just save your files with the size in pixels first, example:
+In the 'icons/' folder: '16-icon.png', '32-icon.png', '512-icon.png'.
+YAMG will choose the best size for the case, and don't touch
+the icon if sizes are a match.
+
+It's ok to (or if you) have only one icon, make it >512px.
+
+
+### Splash
+
+The main splash image must be named 'center'.
+Gravity!
+Just save you files with the names: 'north', 'northeast', 'south'...
+Gravity will put em in the correct place, with a lil padding.
+
+
+### Media
+
+Addional media.
+There's also media generator for app stores.
+
+
+## Screenshots (phantomjs)
+
+Soon.
+
+### Support
+
+* Web
+* Rails
+* iOS Project
+* Android Project
+* Cordova (platforms/*)
+* Phonegap (www/res)
+* App Store
+* Play Store
+* Facebook
+* Twitter
+* Write your own (really easy, fork and change yml)