Skip to content

Commit

Permalink
docs(readme): add new gh highlights
Browse files Browse the repository at this point in the history
This adds quote highlights to the readme
  • Loading branch information
vinnyA3 committed Feb 7, 2024
1 parent 15bf3bd commit e90ddf4
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
Expand Up @@ -38,7 +38,8 @@ https://user-images.githubusercontent.com/11083531/174728256-b21e613e-a148-46f6-

## Dependencies

> :warning: Sorry Windows users, things have been tested on Linux & MacOS only. Support
> [!NOTE]
> Sorry Windows users, things have been tested on Linux & MacOS only. Support
> might be coming soon.
First, make sure you have the following installed on your machine:
Expand Down Expand Up @@ -118,15 +119,17 @@ animego-dl -d

Next, search & select the episode you'd like to download via the cli. Enjoy!

> :warning: The tool will download to your current working directory (where you
> [!NOTE]
> The tool will download to your current working directory (where you
> ran the command), and under a directory named `animego-dl` -- options to
> choose your destination directory will be added soon!
---

## Docker

> :warning: The image requires a connection to your Pulseaudio & Xorg servers,
> [!WARNING]
> The image requires a connection to your Pulseaudio & Xorg servers,
> so make sure you are running an Xdisplay & have Pulseaudio (or pipewire) on
> your host machine. If you're running Ubuntu, PopOS, or some debian
> derivative, you should be fine!
Expand Down Expand Up @@ -200,7 +203,8 @@ To run local tests: `npm run test`

To run tests in watch mode: `npm run test:watch`

> :warning: Tests are few and far between at the moment. In fact, no test
> [!NOTE]
> Tests are few and far between at the moment. In fact, no test
> suites are live at this time - 2/13/22.
## Disclaimer
Expand Down

0 comments on commit e90ddf4

Please sign in to comment.