Skip to content

Commit 039faae

Browse files
committed
update readme
1 parent b9864b7 commit 039faae

1 file changed

Lines changed: 17 additions & 12 deletions

File tree

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
Beta Code Converter for Ruby
2-
============================
1+
# Beta Code Converter for Ruby
32

4-
Overview
5-
--------
3+
## Overview
64

75
Converts Greek beta code to Greek characters and vice versa.
86

9-
Installation
10-
------------
7+
## Installation
118

129
Add this line to your application's Gemfile:
1310

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

2219
`$ gem install beta_code`
2320

24-
Usage
25-
-----
21+
## Usage
2622

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

3632
```
3733

38-
Tests
39-
-----
34+
## Tests
4035

4136
`bundle exec ruby test/test_beta_code.rb`
4237

43-
Notes
44-
-----
38+
## Updating JSON
39+
40+
`git pull -s subtree beta-code-json master`
41+
42+
## Publishing Gem
43+
44+
```bash
45+
gem build beta_code.gemspec
46+
gem push beta_code-X.Y.Z.gem
47+
```
48+
49+
## Notes
4550

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

0 commit comments

Comments
 (0)