Skip to content

Commit 36fb391

Browse files
committed
Added detailed readme's
1 parent d21f125 commit 36fb391

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
# WebEnhanced
1+
## WebEnhanced
22

3-
This is a userscript initiated from [@violentmonkey/generator-userscript](https://github.com/violentmonkey/generator-userscript).
3+
This is an assortment of userscripts developed for ViolentMonkey, with untested suppot for Greasemonkey
4+
and other userscript managers that support modern ES 6 features.
45

5-
## Development
6+
### Building
7+
There should be a github action that builds the userscripts for release automatically.
8+
However, if you want to build it yourself this project was setup using `yarn 2`
69

7-
``` sh
8-
$ yarn dev
9-
```
10+
All you need to do is download the source files, and run `yarn build` in the directory
11+
it should then output all of the userscripts to a `dist` folder.
1012

11-
## Building
13+
### Userscripts
14+
The userscript source code is located within the [src folder](src)
15+
inside of that folder is a [README](src/README.md) which will list
16+
each of the individual userscripts and their function.
1217

13-
```sh
14-
$ yarn build
15-
```
16-
17-
## Lint
18-
19-
``` sh
20-
$ yarn lint
21-
```
18+
Within each userscript is another readme that displays it's own function
19+
for example, [Spectacles](src/Spectacles/README.md)

src/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1-
# Userscripts/src
1+
## Current Userscripts
22

3-
This file contains all of the userscript source files,
3+
### Spectacles
4+
Spectacles is an enhancement for [reddit](https://reddit.com).
5+
It automatically removes all blur effects caused by spoilers and displays the hidden image, video or gif.
6+
7+
*More coming soon..*

0 commit comments

Comments
 (0)