Front matter

README.md

@@ -1,13 +1,39 @@
 Nirum
 =====
 
-Nirum is a [distributed object][1] framework/compiler for microservices,
-built on top of the modern Web server technologies such as RESTful HTTP and
-JSON.
+Nirum is an [IDL][1] compiler and [RPC][2]/[distributed object][3] framework
+for [microservices][4], built on top of the modern Web server technologies
+such as RESTful HTTP and JSON.
 
-WIP.
+You can find how its IDL looks like from source codes in the `examples/`
+directory.
 
-[1]: https://en.wikipedia.org/wiki/Distributed_object
+**Note that its design is highly unstable and could be changed.**
+Also the feature set is incomplete yet.
+
+[1]: https://en.wikipedia.org/wiki/Interface_description_language
+[2]: https://en.wikipedia.org/wiki/Remote_procedure_call
+[3]: https://en.wikipedia.org/wiki/Distributed_object
+[4]: https://en.wikipedia.org/wiki/Microservices
+
+
+Installation
+------------
+
+If you already installed [Haskell Platform][5] or [Haskell Stack][6],
+you can build the project in the same way other Haskell projects are built:
+
+    $ cabal sandbox init
+    $ cabal install --only-dependencies
+    $ cabal configure
+    $ cabal build
+
+or:
+
+    $ stack build
+
+[5]: https://www.haskell.org/platform/
+[6]: https://www.haskellstack.org/
 
 
 Getting Started
@@ -36,8 +62,8 @@ Etymology
 ---------
 
 **니름** (IPA: /niɾɯm/; *nireum*) is a sort of telepathy in the fictional world
-of [The Bird That Drinks Tears][2] (눈물을 마시는 새 *Nunmureul masineun sae*)
-by [Lee Yeongdo][3] (이영도).
+of [The Bird That Drinks Tears][7] (눈물을 마시는 새 *Nunmureul masineun sae*)
+by [Lee Yeongdo][8] (이영도).
 
-[2]: https://en.wikipedia.org/wiki/The_Bird_That_Drinks_Tears
-[3]: https://en.wikipedia.org/wiki/Lee_Yeongdo
+[7]: https://en.wikipedia.org/wiki/The_Bird_That_Drinks_Tears
+[8]: https://en.wikipedia.org/wiki/Lee_Yeongdo

nirum.cabal

@@ -4,13 +4,13 @@ synopsis:            Distributed object framework built on top of
                      REST HTTP and JSON
 description:         Distributed object framework for microservices,
                      built on top of RESTful HTTP and JSON
-homepage:            https://bitbucket.org/dahlia/nirum
-bug-reports:         https://bitbucket.org/dahlia/nirum/issues
+homepage:            https://github.com/spoqa/nirum
+bug-reports:         https://github.com/spoqa/nirum/issues
 license:             GPL-3
 license-file:        LICENSE
-author:              Hong Minhee
-maintainer:          [email protected]
-copyright:           (c) 2016 Hong Minhee
+author:              Nirum team
+maintainer:          Nirum team
+copyright:           (c) 2016 Nirum team
 stability:           alpha
 category:            Language
 build-type:          Simple