Skip to content

Commit

Permalink
feat: update Readme, temp disable failing windows tests
Browse files Browse the repository at this point in the history
  • Loading branch information
webketje committed Jul 6, 2022
1 parent b124b51 commit 0a9b4f9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: ['ubuntu-latest', 'windows-latest']
os: ['ubuntu-latest']
node: [8,10,12,14,16]
name: Testing Node ${{ matrix.node }} on ${{ matrix.os }}
steps:
Expand Down
9 changes: 7 additions & 2 deletions README.md
Expand Up @@ -2,9 +2,8 @@

[Marked](http://npm.im/marked) support for [JSTransformers](http://github.com/jstransformers).

[![Build Status](https://img.shields.io/travis/jstransformers/jstransformer-marked/master.svg)](https://travis-ci.org/jstransformers/jstransformer-marked)
[![Build Status][ci-badge]][ci-url]
[![Coverage Status](https://img.shields.io/codecov/c/github/jstransformers/jstransformer-marked/master.svg)](https://codecov.io/gh/jstransformers/jstransformer-marked)
[![Dependency Status](https://img.shields.io/david/jstransformers/jstransformer-marked/master.svg)](http://david-dm.org/jstransformers/jstransformer-marked)
[![NPM version](https://img.shields.io/npm/v/jstransformer-marked.svg)](https://www.npmjs.org/package/jstransformer-marked)

## Installation
Expand All @@ -18,8 +17,14 @@ let marked = require('jstransformer')(require('jstransformer-marked'));

marked.render('# Hello World!').body
//=> '<h1>Hello World!</h1>'

const markedOptions = {}
marked.render('# "Hello World"', markedOptions)
```

## License

MIT

[ci-badge]: https://github.com/jstransformers/jstransformer-marked/actions/workflows/test.yml/badge.svg
[ci-url]: https://github.com/jstransformers/jstransformer-marked/actions/workflows/test.yml

0 comments on commit 0a9b4f9

Please sign in to comment.