Skip to content
This repository
Browse code

review feedback

  • Loading branch information...
commit 5dc5a1eb5e62982b6586cd9c0232881b766bd9b6 1 parent 29490e0
authored

Showing 1 changed file with 14 additions and 10 deletions. Show diff stats Hide diff stats

  1. 24  README.md
24  README.md
Source Rendered
... ...
@@ -1,23 +1,25 @@
1 1
 # scrooge
2 2
 
3  
-Scrooge is a thrift code generator for scala.
  3
+Scrooge is a [thrift](http://thrift.apache.org/) code generator for scala,
  4
+written in scala.
4 5
 
5  
-It's meant to be a drop-in replacement for the apache thrift code generator.
  6
+It's meant to be a replacement for the apache thrift code generator, and
  7
+generates conforming, compatible binary codecs by building on top of
  8
+libthrift.
6 9
 
7 10
 Since scala is API-compatible with java, you can use the apache thrift code
8 11
 generator to generate java files and use them from within scala, but the
9  
-overhead of converting to/from java containers can sometimes be annoying.
10  
-This is an attempt to bypass the problem by generating scala code directly.
11  
-It also uses scala syntax so the generated code is *much* smaller.
12  
-
13  
-The generated code still depends on libthrift.
  12
+generated code uses java collections and mutable "bean" classes, causing some
  13
+annoying boilerplate conversions to be hand-written. This is an attempt to
  14
+bypass the problem by generating scala code directly. It also uses scala
  15
+syntax so the generated code is much more compact.
14 16
 
15 17
 There is a fairly comprehensive set of unit tests, which actually generate
16 18
 code, compile it, and execute it to verify expectations.
17 19
 
18 20
 There are two sub-projects:
19 21
 
20  
-- scrooge-generator: the actual code generator
  22
+- scrooge-generator: the code generator
21 23
 - scrooge-runtime: some base traits used by the generated code
22 24
 
23 25
 
@@ -30,7 +32,8 @@ To build scrooge, use sbt:
30 32
 
31 33
 ## Features
32 34
 
33  
-- Generates native scala thrift codecs, using case classes and functions.
  35
+- Generates native scala thrift codecs, in immutable and "builder" variants,
  36
+  using case classes and functions.
34 37
 
35 38
 - Generated code is templated using a mustache variant, making it easy to
36 39
   edit.
@@ -86,7 +89,8 @@ To use it, add a line like this to your `plugins.sbt` file:
86 89
 
87 90
 ## Finagle integration
88 91
 
89  
-If you pass the `--finagle` option to scrooge, it will generate a finagle
  92
+If you pass the `--finagle` option to scrooge, it will generate a
  93
+[finagle](https://github.com/twitter/finagle)
90 94
 client and server wrapper class for each thrift service.
91 95
 
92 96
 The service wrapper takes a thrift protocol factory (which specifies which

0 notes on commit 5dc5a1e

Please sign in to comment.
Something went wrong with that request. Please try again.