Skip to content
This repository has been archived by the owner on Feb 6, 2021. It is now read-only.

Commit

Permalink
Update README to mention the documentation site + NPM package page
Browse files Browse the repository at this point in the history
  • Loading branch information
M-rcus committed Mar 16, 2020
1 parent 01408d4 commit 67560aa
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ Allows you to download all the files (attachments, shared files etc.) and posts

This application is kind of created as a quick-and-dirty implementation. While I'd like to spend more time cleaning up the structure of the code, I'm more focused on having a working application (as there aren't any that work that well IMO).

Pull requests are welcome if you'd like to refactor parts (or all!) of the application. :smiley:
Pull requests are welcome if you'd like to refactor parts (or all!) of the application. 😃

## Installation

Requires [node.js/npm](https://nodejs.org/).

- `npm install -g yiff-dl`
- Running this command will update `yiff-dl` if there's a new version.
- `npm` by default installs the latest [npm package version](https://www.npmjs.com/package/yiff-dl).
- [See "Basic usage"](#basic-usage)

### Manual installation
Expand Down Expand Up @@ -62,3 +63,9 @@ yiff-dl allows for some customization using more advanced parameters.
## Notes

- There are two HTML/DOM parsers in this project, mainly because I added one in the very beginning of the project and then forgot it existed a few weeks later when I implemented a new feature. Whoops.

## Links

- [Documentation site](https://m-rcus.github.io/yiff-dl/)
- Hosted on GitHub pages, reads from this `README.md` file!
- [`yiff-dl` on NPM](https://www.npmjs.com/package/yiff-dl)

0 comments on commit 67560aa

Please sign in to comment.