summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md21
1 files changed, 12 insertions, 9 deletions
diff --git a/README.md b/README.md
index e82458f06..91addce80 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,20 @@
mruby-pack (pack / unpack)
=========
-## install by mrbgems
-```bash
-git clone git://github.com/iij/mruby-pack.git
-cp -pr mruby-pack ${MRUBY_ROOT}/mrbgems/g/.
-echo mruby-pack >> ${MRUBY_ROOT}/mrbgems/GEMS.active
-cd ${MRUBY_ROOT}
-rake ENABLE_GEMS="true"
-./bin/mruby ${MRUBY_ROOT}/mrbgems/g/mruby-pack/example/sample.rb
+mruby-pack provides `Array#pack` and `String#unpack` for mruby.
+
+
+## Installation
+Add the line below into your `build_config.rb`:
+
```
+ conf.gem :github => 'iij/mruby-pack'
+```
+
+There is no dependency on other mrbgems.
+
-## supported template string
+## Supported template string
- A : arbitrary binary string (space padded, count is width)
- a : arbitrary binary string (null padded, count is width)
- C : 8-bit unsigned (unsigned char)