diff --git a/README.md b/README.md index 305dfab..6cd8670 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# prodoc +# protodoc -[![Build Status](https://img.shields.io/travis/coreos/prodoc.svg?style=flat-square)][cistat] [![Godoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)][prodoc-godoc] +[![Build Status](https://img.shields.io/travis/coreos/protodoc.svg?style=flat-square)][cistat] [![Godoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)][protodoc-godoc] -prodoc generates Protocol Buffer documentation. +protodoc generates Protocol Buffer documentation. Note that parser only understands the minimum syntax of Protocol Buffer (just enough to generate documentation). For full featured parser, please check out https://github.com/golang/protobuf. -[cistat]: https://travis-ci.org/coreos/prodoc -[prodoc-godoc]: https://godoc.org/github.com/coreos/prodoc +[cistat]: https://travis-ci.org/coreos/protodoc +[protodoc-godoc]: https://godoc.org/github.com/coreos/protodoc