Cleaned up README.

README

@@ -1,40 +1,40 @@
 
 upb - a minimalist implementation of protocol buffers.
 
-- For API documentation, see the header files.
+For API documentation, see the header files.
-- To build type "make".
+
-
+To build:
-
+$ make
-ROADMAP OF THE SOURCE
+
-=====================
+Other useful targets:
-
+$ make test
-benchmark/
+$ make benchmark
-  Benchmarks of upb and other protocol buffer implementations.
+
-core/
+Issue tracking is on Google Code:
-  The core source directory.  builds into core/libupb.a.  Contains only the
+  http://code.google.com/p/upb/issues/list
-  very core library, which is capable of loading descriptors given the
+
-  appropriate decoder.  Does not even contain decoders for the standard
+A manual is forthcoming, for now see wiki docs at:
-  formats like the protobuf text and binary formats.
+  https://github.com/haberman/upb/wiki
-descriptor/
+
-  Files that describe the format of Protocol Buffer "descriptors", which are
+API and ABI are both subject to change!  Please do not distribute as a shared
-  protocol buffers that describe the format of other protocol buffers.  These
+library for this reason (for now at least).
-  are used extensively inside upb.
+
-labs/
+TODO
-  Code that is not part of upb, but contains efficiency-related experiments
+====
-  about alternate ways of implementing things.  When possible, these are
+
-  benchmarked by the tests in benchmark/.  We also test these with the tests
+The issue tracker contains small-to-medium tasks that need doing; but here are
-  in tests/, to ensure that the alternate implementations are actually correct.
+the major things that are broken or not yet implemented yet:
-stream/
+
-  Implementations of streaming protobuf encoders and decoders.
+- serialization isn't written yet (only deserialization)
-tests/
+
-  Unit tests.
+- the language extensions that exist so far (Python and Lua) are totally
-tools/
+  incomplete/broken.  They are not usable for anything yet.  This will
-  Command-line tools like the upb compiler.
+  be remedied very soon.
 
 
 CONTACT
 =======
 
-Author: Joshua Haberman (joshua@reverberate.org, haberman@google.com)
+Author: Joshua Haberman (jhaberman@gmail.com, haberman@google.com)
 See LICENSE for copyright information.