Skip to content

Commit

Permalink
feat: add installation steps to README
Browse files Browse the repository at this point in the history
  • Loading branch information
cherfia committed Mar 28, 2022
1 parent c781cee commit a0bb726
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

A lightweight Typescrpit library which interacts with [Gotenberg](https://gotenberg.dev/)'s different modules to convert a variety of document formats to PDF files.

## Install

Using npm:

```bash
npm install chromiumly
```

Using yarn:

```bash
yarn add chromiumly
```

## Prerequisites

Before attempting to use Chromiumly, be sure you install [Docker](https://www.docker.com/) if you have not already done so.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "chromiumly",
"version": "2.0.0",
"version": "2.0.1",
"description": "A lightweight Typescrpit library which interacts with Gotenberg's different modules to convert a variety of document formats to PDF files.",
"main": "dist/main.js",
"types": "dist/main.d.ts",
Expand Down

0 comments on commit a0bb726

Please sign in to comment.