From 81a202a456cbc531b988e89ea566ff6668c0bf32 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Carlos=20Nieto?= <xiam@menteslibres.org>
Date: Tue, 10 Jul 2012 06:35:37 -0500
Subject: [PATCH] Updating docs.
---
README.md | 35 ++++++++++++++++++++++++++++++-----
1 file changed, 30 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 2f2dd9ae..c73f56fe 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,35 @@
# What is gosexy?
-gosexy is a general purpose framework for Go that provides sugar methods, types and abstractions.
+gosexy is a general purpose framework for Go that provides [sugar](http://en.wikipedia.org/wiki/Syntactic_sugar) methods, types and abstractions.
-## Installing gosexy
+## Getting sexy
-Before running this command, make sure you have the ``git``, ``hg`` (mercurial) and ``bzr`` (bazaar) source control systems installed on your system, those packages are available for many linux distros and also in [homebrew](http://mxcl.github.com/homebrew/) for OSX.
+### Before pulling the source
+
+Make sure you have the ``git``, ``hg`` (mercurial) and ``bzr`` (bazaar) source control systems installed on your system, those packages are available for many linux distros and also in [homebrew](http://mxcl.github.com/homebrew/) for OSX. You'll also require ``sqlite3`` and ``pkg-config``. All those packages are required for building some third party wrappers.
+
+Here's how you would install on OSX using brew
+
+ $ brew install git
+ $ brew install hg
+ $ brew install bzr
+ $ brew install sqlite3
+ $ brew install pkg-config
+
+Or, let's suppose you want to get them all in ArchLinux
+
+ # sudo pacman -S mercurial bzr sqlite3 git pkg-config
+
+### Using gosexy in your Go program
+
+First, get the source using go
$ go get github.com/xiam/gosexy
+Then import ``gosexy`` into your actual source code
+
+ import . "github.com/xiam/gosexy"
+
## Sugar wrappers
* [gosexy/db](https://github.com/xiam/gosexy/tree/master/db) - A wrapper of database/sql, mgo and friends for querying to MongoDB, MySQL, PostgreSQL or SQLite3 databases in a consistent way.
@@ -15,6 +37,9 @@ Before running this command, make sure you have the ``git``, ``hg`` (mercurial)
## Sugar types
-``Tuple`` is a shortcut for ``map[string]interface{}`` (generic dictionaries).
+* ``Tuple`` is a shortcut for ``map[string]interface{}`` (generic dictionaries).
+* ``List`` is a shortcut for ``[]interface{}`` (generic arrays).
+
+## License
-``List`` is a shortcut for ``[]interface{}`` (generic arrays).
+gosexy and friends are all released under the terms of the [MIT License](https://raw.github.com/xiam/gosexy/master/LICENSE).
--
GitLab