From 747ee562a1ee78942ad14e29f6000dda8dede553 Mon Sep 17 00:00:00 2001 From: Yonaba Date: Thu, 27 Apr 2017 15:40:18 +0000 Subject: [PATCH] Beautified README --- README.md | 44 +++++++++++++++++++++----------------------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 3f7e838..0bf99e5 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@ [![Build Status](https://travis-ci.org/Yonaba/Moses.png)](https://travis-ci.org/Yonaba/Moses) -[![Coverage Status](https://coveralls.io/repos/Yonaba/Moses/badge.png?branch=master)](https://coveralls.io/r/Yonaba/Moses?branch=master) [![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE) -[![Join the chat at https://gitter.im/Yonaba/Moses](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Yonaba/Moses?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Lua](https://img.shields.io/badge/Lua-5.1%2C%205.2%2C%205.3%2C%20JIT-blue.svg)]() +[![git-brag-stats](https://labs.turbo.run/git-brag?user=Yonaba&repo=Moses)](https://github.com/turbo/git-brag) -A Lua utility-belt library for [functional programming](http://en.wikipedia.org/wiki/Functional_programming). It complements the built-in __Lua table library__, making easier -operations on arrays, lists, collections.
+A Lua utility-belt library for [functional programming](http://en.wikipedia.org/wiki/Functional_programming).
-__Moses__ was deeply inspired by [Underscore.js](http://underscorejs.org). +## Download + +### Archive +* __zip__: [1.6.1 (stable)](http://github.com/Yonaba/Moses/archive/Moses-1.6.1-1.zip) | [dev](http://github.com/Yonaba/Moses/archive/master.zip) | [all releases](http://github.com/Yonaba/Moses/tags) +* __tarball__: [1.6.1 (stable)](http://github.com/Yonaba/Moses/archive/Moses-1.6.1-1.tar.gz) | [dev](http://github.com/Yonaba/Moses/archive/master.tar.gz) | [all releases](http://github.com/Yonaba/Moses/tags) -## Download & Installation ### Bash ```bash git clone git://github.com/Yonaba/Moses.git ```` -### Archive -* __zip__: [1.6.0 (latest stable)](http://github.com/Yonaba/Moses/archive/Moses-1.6.0-1.zip) | [current](http://github.com/Yonaba/Moses/archive/master.zip) | [all](http://github.com/Yonaba/Moses/tags) -* __tarball__: [1.6.0 (latestt stable)](http://github.com/Yonaba/Moses/archive/Moses-1.6.0-1.tar.gz) | [current](http://github.com/Yonaba/Moses/archive/master.tar.gz) | [all](http://github.com/Yonaba/Moses/tags) - ### LuaRocks ``` luarocks install moses @@ -30,42 +28,42 @@ luarocks install moses moonrocks install moses ```` -or : +## Usage -```bash -luarocks install --server=http://rocks.moonscript.org/manifests/Yonaba moses +```lua +local _ = require "moses" ```` -## Usage -Put the file [moses.lua](https://github.com/Yonaba/Moses/blob/master/moses.lua) inside your project folder and call it using *require* command. - -*Note:* the full source [moses.lua](https://github.com/Yonaba/Moses/blob/master/moses.lua) is quite heavy (~68 kiB). You can alternatively use the [minified version](https://github.com/Yonaba/Moses/blob/master/moses_min.lua) (~22 kiB). +*Note:* the full source [moses.lua](https://github.com/Yonaba/Moses/blob/master/moses.lua) is quite heavy (~70 kiB). You can alternatively use the [minified version](https://github.com/Yonaba/Moses/blob/master/moses_min.lua) (~22 kiB). ## Tutorial -Find a complete set of code examples in [tutorial.md](https://github.com/Yonaba/Moses/blob/master/doc/tutorial.md) + +Find a complete set of code examples in [tutorial.md](https://github.com/Yonaba/Moses/blob/master/doc/tutorial.md). ## Documentation -* Available in HTML-format for download : see [doc](https://github.com/Yonaba/Moses/blob/master/doc). -* Read it in your browser : see [online doc](http://yonaba.github.io/Moses/doc) + +* See *doc* folder : [doc](https://github.com/Yonaba/Moses/blob/master/doc) +* Or browse it online : see [online doc](http://yonaba.github.io/Moses/doc). ## Credits and Acknowledgement + * [Jeremy Ashkenas](https://github.com/jashkenas), for the amazing [Underscore.js](http://documentcloud.github.com/underscore/) * [Marcus Irven](http://mirven.github.com/underscore.lua/)'s and [JTArchie](https://github.com/jtarchie/underscore-lua)'s 1-to-1 ports that also inspired this * [Matthew Rocklin](https://github.com/mrocklin)'s [Toolz](https://github.com/pytoolz/toolz/) from which I borrowed some ideas * [LDoc](https://github.com/stevedonovan/ldoc/) used to generate the current HTML documentation. ## Specification -Spec tests have been included.
-Run them using [Telescope](https://github.com/norman/telescope) with the following command from the root folder: + +Run [spec tests](https://github.com/Yonaba/Moses/blob/master/spec) using [Telescope](https://github.com/norman/telescope) with the following command from the root folder: ```` tsc -f spec/* ```` ## License + This work is under [MIT-LICENSE](http://www.opensource.org/licenses/mit-license.php)
Copyright (c) 2012-2017 Roland Yonaba.
See [LICENSE](LICENSE). -[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Yonaba/moses/trend.png)](https://bitdeli.com/free "Bitdeli Badge")