diff --git a/.travis.yml b/.travis.yml index b6c760e..7a21e57 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,7 +4,8 @@ sudo: false node_js: - "0.10" - "0.12" - - "iojs" + - "4" + - "5" after_success: - npm run coverage diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index d4c9c31..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,13 +0,0 @@ -# Change Log -All notable changes to this project will be documented in this file. -This project adheres to [Semantic Versioning](http://semver.org/). - -## 0.1.0 - 2015-08-06 -### Added -- more keywords - -### Changed -- fix boilerplate stuff - -## 0.0.0 - 2015-08-06 -- Initial release and publish to npm diff --git a/HISTORY.md b/HISTORY.md new file mode 100644 index 0000000..390ef20 --- /dev/null +++ b/HISTORY.md @@ -0,0 +1,9 @@ +# Changelog + +## v0.2.0: 2016-06-16 + +- Updated Boilerplate + +## v0.1.0: 2015-08-06 + +- Initial release diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 9e265e1..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2015 JSTransformers - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..feebf76 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License (MIT) + +Copyright (c) 2015 [JSTransformers Team](https://github.com/orgs/jstransformers/people) + +> Permission is hereby granted, free of charge, to any person obtaining a copy +> of this software and associated documentation files (the "Software"), to deal +> in the Software without restriction, including without limitation the rights +> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +> copies of the Software, and to permit persons to whom the Software is +> furnished to do so, subject to the following conditions: +> +> The above copyright notice and this permission notice shall be included in +> all copies or substantial portions of the Software. +> +> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +> SOFTWARE. diff --git a/README.md b/README.md index dfee413..4af6665 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,17 @@ -# jstransformer-megamark [![The MIT License][license-img]][license-url] +# jstransformer-megamark - +[Megamark](https://github.com/bevacqua/megamark) support for [JSTransformers](http://github.com/jstransformers). -[megamark](https://github.com/bevacqua/megamark) support for [JSTransformers][jstransformers-url]. +[![Build Status](https://img.shields.io/travis/jstransformers/jstransformer-megamark/master.svg)](https://travis-ci.org/jstransformers/jstransformer-megamark) +[![Coverage Status](https://img.shields.io/coveralls/jstransformers/jstransformer-megamark/master.svg)](https://coveralls.io/r/jstransformers/jstransformer-megamark?branch=master) +[![Dependency Status](https://img.shields.io/david/jstransformers/jstransformer-megamark/master.svg)](http://david-dm.org/jstransformers/jstransformer-megamark) +[![NPM version](https://img.shields.io/npm/v/jstransformer-megamark.svg)](https://www.npmjs.org/package/jstransformer-megamark) -[![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] [![npmjs.com][npmjs-img]][npmjs-url] +## Installation + npm install jstransformer-megamark -## Install -``` -npm install jstransformer-megamark --save -npm test -``` - - -## Usage -> For more use-cases see the **tests** in [test folder](./test) or see the [JSTransformer API](http://github.com/jstransformers/jstransformer#api) for more details. +## API ```js var megamark = require('jstransformer')(require('jstransformer-megamark')); @@ -24,28 +20,6 @@ console.log(megamark.render('_Hello_, **world**!').body); //=> '

Hello, world!

' ``` - -## Contributing -Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jstransformers/jstransformer-megamark/issues/new). - - ## License -[The MIT License][license-url] - - -[npmjs-url]: https://www.npmjs.com/package/jstransformer-megamark -[npmjs-img]: https://img.shields.io/npm/v/jstransformer-megamark.svg - -[license-url]: ./LICENSE -[license-img]: https://img.shields.io/badge/license-MIT-blue.svg - -[travis-url]: https://travis-ci.org/jstransformers/jstransformer-megamark -[travis-img]: https://img.shields.io/travis/jstransformers/jstransformer-megamark.svg - -[coveralls-url]: https://coveralls.io/r/jstransformers/jstransformer-megamark -[coveralls-img]: https://img.shields.io/coveralls/jstransformers/jstransformer-megamark.svg - -[david-url]: https://david-dm.org/jstransformers/jstransformer-megamark -[david-img]: https://img.shields.io/david/jstransformers/jstransformer-megamark.svg -[jstransformers-url]: http://github.com/jstransformers +MIT diff --git a/package.json b/package.json index 4a8f2e0..71612c4 100644 --- a/package.json +++ b/package.json @@ -1,17 +1,12 @@ { + "dependencies": { + "megamark": "^3.1.0" + }, "name": "jstransformer-megamark", - "version": "0.1.0", - "description": "megamark support for JSTransformers.", + "version": "0.2.0", + "description": "Megamark support for JSTransformers.", "keywords": [ - "it", - "jstransformer", - "markdown", - "markdown-it", - "md", - "megamark", - "tokenize", - "tokens", - "transform" + "jstransformer" ], "files": [ "index.js" @@ -23,10 +18,16 @@ "coverage": "test-jstransformer coverage", "test": "test-jstransformer" }, - "repository": "jstransformers/jstransformer-megamark", - "author": "JSTransformers Team (https://github.com/orgs/jstransformers/people)", - "license": "MIT", - "dependencies": { - "megamark": "^3.1.0" - } + "engines": { + "node": ">=0.10.36" + }, + "repository": { + "type": "git", + "url": "https://github.com/jstransformers/jstransformer-foo.git" + }, + "author": { + "name": "JSTransformers Team", + "url": "http://github.com/orgs/jstransformers/people" + }, + "license": "MIT" }