Skip to content

Commit

Permalink
Add issue reporting explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
emmanuelmenon committed Jan 14, 2021
1 parent ab9b0ed commit 341ed3c
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This project is my attempt at increasing the readability of [Project Gutenberg](https://www.gutenberg.org/)'s HTML books. Results will be a little inconsistent across Gutenberg's catalog because of how Project Gutenberg styles their books, but if you do notice any weirdness, don't hesitate to [open an issue](https://github.com/emmanuelmenon/better-gutenberg/issues/new), or to [submit a pull request](https://github.com/emmanuelmenon/better-gutenberg/compare).

## Installing
You'll need to install Stylus or some sort of userstyle extension. You can install Stylus at any of these links:
You'll need to install [Stylus](https://github.com/openstyles/stylus) or some sort of userstyle extension. You can install Stylus at any of these links:
- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/styl-us/)
- [Chrome](https://chrome.google.com/webstore/detail/stylus/clngdbkpkpeebahjckkjfobafhncgmne)
- [Opera](https://addons.opera.com/en-gb/extensions/details/stylus/)
Expand All @@ -11,6 +11,9 @@ Once Stylus is installed, click on the badge below to install the custom style.

[![Install directly with Stylus](https://img.shields.io/badge/Install%20directly%20with-Stylus-00adad.svg)](https://raw.githubusercontent.com/emmanuelmenon/better-gutenberg/main/better-gutenberg.user.css)

## Issues
If you do notice an issue with how a book looks, [open an issue](https://github.com/emmanuelmenon/better-gutenberg/issues/new/choose) and select the appropriate template. Fill it out and hit "Submit new issue". I'll attempt to sort it out as soon as I can!

## License
```
This is free and unencumbered software released into the public domain.
Expand Down

0 comments on commit 341ed3c

Please sign in to comment.