Skip to content

Commit

Permalink
update readme with deno/x links
Browse files Browse the repository at this point in the history
  • Loading branch information
littletof committed Feb 1, 2021
1 parent e5f8dc9 commit f72b31a
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# 🎩 charMD

[![deno badge](https://img.shields.io/badge/deno.land/x-success?logo=deno&logoColor=black&labelColor=white&color=black)](https://deno.land/x/charmd)

*A simple, extendable markdown renderer for your terminal.*

> 🚧 This module is in early developement, expect breaking changes 🚧
**`charMD`** enables you to render a markdown text into a string, which printed in the terminal provides a well formatted output, instead of plain text.
Expand All @@ -11,21 +15,21 @@
To see the general capabilities of this module run:

```bash
deno run https://raw.githubusercontent.com/littletof/terminal_markdown/master/example.ts
deno run https://deno.land/x/charmd/example.ts
```

To see, how a specific markdown gets rendered run:

```bash
deno run --allow-read https://raw.githubusercontent.com/littletof/terminal_markdown/master/example.ts ./README.md
deno run --allow-read https://deno.land/x/charmd/example.ts ./README.md
```

## Usage

Simply import the module and call the `renderMarkdown` method with your markdown text.

```ts
import { renderMarkdown } from 'https://raw.githubusercontent.com/littletof/terminal_markdown/master/mod.ts';
import { renderMarkdown } from 'https://deno.land/x/charmd/mod.ts';

console.log(renderMarkdown('# Hello world 🌍!'));
```
Expand Down Expand Up @@ -67,7 +71,7 @@ console.log(renderMarkdown(
For direct use in the terminal run `cli.ts`:

```bash
deno run --allow-net https://raw.githubusercontent.com/littletof/terminal_markdown/master/cli.ts -r https://raw.githubusercontent.com/denoland/deno/master/README.md
deno run --allow-net https://deno.land/x/charmd/cli.ts -r https://raw.githubusercontent.com/denoland/deno/master/README.md
```

Or install it with `deno install`
Expand Down

0 comments on commit f72b31a

Please sign in to comment.