Permalink
Browse files

modified README

  • Loading branch information...
1 parent c416c3f commit 437b3e25be35cb85f4e8f1cfc6eab7c99b096a12 @aishek committed Apr 9, 2012
Showing with 41 additions and 19 deletions.
  1. +41 −0 README.md
  2. +0 −19 README.rdoc
View
@@ -0,0 +1,41 @@
+# Introduction
+
+Languager extends string to translate it to specified language by keyboard layout (like Punto Switcher). Currently supporting only translation from english to russian. It will be useful to autocorrect user's input in wrong keyboard layout in search queries.
+
+This document describes installation and usage of languager.
+
+Please report issues on [Github](https://github.com/aishek/languager/issues).
+
+For feedback, suggestions, etc. write to <aishek@gmail.com>.
+
+[![Build Status](https://secure.travis-ci.org/aishek/languager.png)](http://travis-ci.org/aishek/languager)
+
+# Installation
+
+To install:
+
+ gem install languager
+
+or with a Gemfile:
+
+ gem 'languager'
+ bundle install
+
+# Usage
+
+Usage in Ruby program:
+
+ require 'languager'
+
+ query = "ghbdtn^ vbh!"
+ query.to_ru # 'привет, мир!'
+
+# Documentation
+
+The [RubyDoc documentation](http://rubydoc.info/github/aishek/languager/master/frames) is available online.
+
+# Copyright
+
+Copyright (c) 2012 Alexandr Borisov. See LICENSE.txt for
+further details.
+
View
@@ -1,19 +0,0 @@
-= languager
-
-Description goes here.
-
-== Contributing to languager
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Alexandr Borisov. See LICENSE.txt for
-further details.
-

0 comments on commit 437b3e2

Please sign in to comment.