aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOskari Timperi <oskari.timperi@iki.fi>2018-04-07 00:19:17 +0300
committerOskari Timperi <oskari.timperi@iki.fi>2018-04-07 00:19:17 +0300
commit5bc364b94c90b1e6e3910bd29adc75e0affa0d10 (patch)
tree32ecc1c3fe1af5a23afade2c4c31bfad5cce9b70 /README.md
parent4b6946251d36b16048d6b5aa4aee493313cf7ca9 (diff)
downloadnimpb-5bc364b94c90b1e6e3910bd29adc75e0affa0d10.tar.gz
nimpb-5bc364b94c90b1e6e3910bd29adc75e0affa0d10.zip
Remove generator in favor of nimpb_build
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8791440..2a0aed3 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
# Protocol Buffers for Nim
-A Nim library to serialize/deserialize Protocol Buffers and a `protoc` plugin for generating Nim code from `.proto` files.
+A Nim library to serialize/deserialize Protocol Buffers.
-At the moment this is at a very rough state. Do not use for any kind of production use. Anything can change at any time. You've been warned.
+For generating Nim code usable with nimpb, you should use [nimpb_build](https://github.com/oswjk/nimpb-build).
+
+**NOTE** At the moment this is at a very rough state. Do not use for any kind of production use. Anything can change at any time. You've been warned.
# Example
@@ -23,7 +25,7 @@ message Test1 {
}
```
-The `protoc` plugin will generate the following types (and procs for interacting with them):
+You can use [nimpb_build](https://github.com/oswjk/nimpb-build) to generate code like this (procs not included in the example):
```nim
type