Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KhudaDad414 authored Dec 28, 2021
1 parent ee84bea commit f5a0c0f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# workflows-to-markdown [![NPM version](https://img.shields.io/npm/v/workflows-to-markdown.svg?style=flat)](https://www.npmjs.com/package/workflows-to-markdown)

> create an event map from your workflows and save it in a Markdown file.
Workflows to markdown is supposed to generate a map of your event-workflows. It will show you what event causes which workflows to run.


## Install

> Note: You can use [Workflows to Markdown Action](https://github.com/KhudaDad414/workflows2md-action) if you want to automate the process of map generation.
Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save workflows-to-markdown
$ npm install --save-dev workflows-to-markdown
```

## CLI
Expand Down

0 comments on commit f5a0c0f

Please sign in to comment.