Skip to content

Commit

Permalink
Merge pull request #122 from marp-team/update-readme
Browse files Browse the repository at this point in the history
Small update for README.md and docs
  • Loading branch information
yhatt authored Jan 22, 2019
2 parents 6df8829 + e8e9f1c commit 8cc85ee
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## [Unreleased]

### Changed

- Small update for README and docs ([#122](https://github.com/marp-team/marpit/pull/122))

## v0.6.0 - 2019-01-19

### Added
Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
<strong>Marpit</strong>: Markdown slide deck framework
</p>
<p align="center">
<a href="https://circleci.com/gh/marp-team/marpit/"><img src="https://img.shields.io/circleci/project/github/marp-team/marpit/master.svg?style=flat-square" alt="CircleCI" /></a>
<a href="https://codecov.io/gh/marp-team/marpit"><img src="https://img.shields.io/codecov/c/github/marp-team/marpit/master.svg?style=flat-square" alt="Codecov" /></a>
<a href="https://www.npmjs.com/package/@marp-team/marpit"><img src="https://img.shields.io/npm/v/@marp-team/marpit.svg?style=flat-square" alt="npm" /></a>
<a href="https://circleci.com/gh/marp-team/marpit/"><img src="https://img.shields.io/circleci/project/github/marp-team/marpit/master.svg?style=flat-square&logo=circleci" alt="CircleCI" /></a>
<a href="https://codecov.io/gh/marp-team/marpit"><img src="https://img.shields.io/codecov/c/github/marp-team/marpit/master.svg?style=flat-square&logo=codecov" alt="Codecov" /></a>
<a href="https://www.npmjs.com/package/@marp-team/marpit"><img src="https://img.shields.io/npm/v/@marp-team/marpit.svg?style=flat-square&logo=npm" alt="npm" /></a>
<a href="./LICENSE"><img src="https://img.shields.io/github/license/marp-team/marpit.svg?style=flat-square" alt="LICENSE" /></a>
</p>

Expand All @@ -17,8 +17,9 @@

Marpit is designed to _output minimum assets for the slide deck_. You can use the bare assets as a logicless slide deck, but mainly we expect to integrate output with other tools and applications.

This framework is actually created for use as [a core][marp-core] of the next version of [Marp](https://github.com/yhatt/marp/).
In fact, this framework is created for using as the base of [a core converter][marp-core] in [the next version of Marp][marp].

[marp]: https://github.com/marp-team/marp/
[marp-core]: https://github.com/marp-team/marp-core/

## Features
Expand Down Expand Up @@ -57,6 +58,10 @@ yarn build

Are you interested in contributing? Please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).

## Sub-projects

- **[@marp-team/marpit-svg-polyfill](https://github.com/marp-team/marpit-svg-polyfill)** - A polyfill of the inline SVG slide in Safari based browsers.

## Author

Managed by [@marp-team](https://github.com/marp-team).
Expand Down
3 changes: 2 additions & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[marp]: https://github.com/marp-team/marp/
[marp-core]: https://github.com/marp-team/marp-core

<p style="text-align:center;">
Expand All @@ -13,7 +14,7 @@

Marpit is designed to _output minimum assets for the slide deck_. You can use the bare assets as a logicless slide deck, but mainly we expect to integrate output with other tools and applications.

This framework is actually created for use as [a core][marp-core] of the next version of [Marp](https://github.com/yhatt/marp/).
In fact, this framework is created for using as the base of [a core converter][marp-core] in [the next version of Marp][marp].

## Features

Expand Down

0 comments on commit 8cc85ee

Please sign in to comment.