Skip to content

Commit

Permalink
Tweak readme, use tslib
Browse files Browse the repository at this point in the history
  • Loading branch information
paldepind committed May 19, 2017
1 parent 94d9e9c commit dc0c610
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 19 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,26 @@
# Jabz

Powerful and practical abstractions for JavaScript. Functors, monads,
foldables traversables and all that jazz.
foldables, traversables, and all that jazz.

[![Build Status](https://travis-ci.org/Funkia/jabz.svg?branch=master)](https://travis-ci.org/Funkia/jabz)
[![codecov](https://codecov.io/gh/Funkia/jabz/branch/master/graph/badge.svg)](https://codecov.io/gh/Funkia/jabz)
[![Build Status](https://travis-ci.org/funkia/jabz.svg?branch=master)](https://travis-ci.org/funkia/jabz)
[![codecov](https://codecov.io/gh/funkia/jabz/branch/master/graph/badge.svg)](https://codecov.io/gh/funkia/jabz)
[![Gitter chat](https://badges.gitter.im/Join_Chat.svg)](https://gitter.im/funkia/General?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Goals and features

* Be as simple and convenient as possible in usage
* Allow for performant implementations
* Support TypeScript to the extent possible
* TypeScript support
* Batteries included. Provide implementations of often used instances
and commonly used utility functions.
* Do-notation
* [Seamless instances](#seamless-instances)
* Comes with files in ES2015 module format for tree-shaking

For a more detailed introduction to the design of the specification
and a comparison to Fantasy Land please
see [this blog post](http://vindum.io/blog/introducing-jabz/).
and a comparison to Fantasy Land please see [this blog
post](http://vindum.io/blog/introducing-jabz/).

## Install

Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@
"url": "https://github.com/paldepind/jabz/issues"
},
"homepage": "https://github.com/paldepind/jabz#readme",
"dependencies": {},
"dependencies": {
"tslib": "^1.7.1"
},
"devDependencies": {
"@types/chai": "^3.5.2",
"@types/mocha": "^2.2.41",
Expand Down
16 changes: 4 additions & 12 deletions tsconfig-release.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"declaration": true,
"noImplicitAny": true,
"sourceMap": true,
"outDir": "dist/",
"experimentalDecorators": true,
"lib": ["dom", "es5", "es2015.core", "es2015.promise", "es2015.iterable", "es2015.generator"]
"outDir": "dist/"
},
"include": [
"src/**/*.ts"
],
"exclude": [
"node_modules"
"test/**/*.ts"
]
}
}
2 changes: 2 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
"compilerOptions": {
"target": "es6",
"module": "commonjs",
"moduleResolution": "node",
"declaration": true,
"noImplicitAny": true,
"sourceMap": true,
"experimentalDecorators": true,
"importHelpers": true,
"lib": ["dom", "es5", "es2015.core", "es2015.promise", "es2015.iterable", "es2015.generator"]
},
"files": [
Expand Down

0 comments on commit dc0c610

Please sign in to comment.