Skip to content

Commit

Permalink
readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
ninjudd committed Jul 17, 2012
1 parent 7653c26 commit 40e64b9
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,36 @@
lein-protobuf is a Leiningen plugin for compiling [Google Protocol Buffer](http://code.google.com/p/protobuf/)
`.proto` files into Java `.class` files.
lein-protobuf is a [Leiningen](https://github.com/technomancy/leiningen) plugin for compiling
[Google Protobuf](http://code.google.com/p/protobuf/) `.proto` files into Java `.class` files. It
can be used with or without [clojure-protobuf](https://github.com/flatland/clojure-protobuf), which
is a Clojure wrapper around the Java protobuf API.

lein-protobuf can be used with or without [clojure-protobuf](https://github.com/flatland/clojure-protobuf),
which is a Clojure wrapper around the Java protobuf API.
## Getting started

## Usage

lein-protobuf requires at least version 2.0 of Leiningen. Add the following to your `project.clj`
file:
Add the following to your `project.clj` file:

:plugins [[lein-protobuf "0.1.1"]]

Replace `"0.1.1"` with the actual latest version, which you can find on
[clojars](http://clojars.org/lein-protobuf).
Replace `"0.1.1"` with the actual latest version, which you can find at http://clojars.org/lein-protobuf.

### proto-path
*Note: lein-protobuf requires at least version 2.0 of Leiningen.*

## Usage

By default, lein-protobuf looks for `.proto` files in `resources/proto` in your project
directory. This was chosen as the default location so that `.proto` files would also be included in
your jar files. You can change this with:

:proto-path "path/to/proto"

To compile all `.proto` files this directory, just run:
To compile all `.proto` files in this directory, just run:

lein protobuf

You can also compile specific proto files with:

lein protobuf file1.proto file2.proto

lein-protobuf also adds a hook to Leiningen's `compile` task, so `.proto` files will automatically
be compiled before that task runs. So if you like, you can simply run:
We also add a hook to Leiningen's `compile` task, so `.proto` files will automatically be compiled
before that task runs. So if you like, you can simply run:

lein compile

Expand Down

0 comments on commit 40e64b9

Please sign in to comment.