Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zfletch committed Aug 21, 2019
1 parent b9864b7 commit 039faae
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
Beta Code Converter for Ruby
============================
# Beta Code Converter for Ruby

Overview
--------
## Overview

Converts Greek beta code to Greek characters and vice versa.

Installation
------------
## Installation

Add this line to your application's Gemfile:

Expand All @@ -21,8 +18,7 @@ Or install it yourself as:

`$ gem install beta_code`

Usage
-----
## Usage

```ruby
require 'beta_code'
Expand All @@ -35,12 +31,21 @@ BetaCode::beta_code_to_greek 'mh=nin a)/eide qea\\ *phlhi+a/dew *)axilh=os'

```

Tests
-----
## Tests

`bundle exec ruby test/test_beta_code.rb`

Notes
-----
## Updating JSON

`git pull -s subtree beta-code-json master`

## Publishing Gem

```bash
gem build beta_code.gemspec
gem push beta_code-X.Y.Z.gem
```

## Notes

For the mappings between beta code and Unicode, see [https://github.com/zfletch/beta-code-json](https://github.com/zfletch/beta-code-json).

0 comments on commit 039faae

Please sign in to comment.