Skip to content
This repository has been archived by the owner on Dec 4, 2022. It is now read-only.

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carlo- committed Jan 22, 2018
1 parent c8f67d2 commit 3fa2f1f
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# jsInjector
##### v0.1 alpha
![Platforms](https://img.shields.io/badge/platform-Safari-lightgrey.svg) ![License](https://img.shields.io/badge/license-MIT-blue.svg)

jsInjector is a Safari extension that allows users to inject arbitrary JS into specific web pages.\
The rules can be set up through a control panel and are based on URLs.

<p align="center">
<img alt="Example" src="https://i.imgur.com/vGLLRLC.png" width="auto" height="600">
<br/>
(bad) example usage
</p>

---
## Installation
x

---
## Setup for development
The control panel is built with ReactJS and npm is required for the development.

In order to **install** all of the necessary dependencies run:
```bash
cd ./jsinjector-rules
npm install
```

To **debug** run:
```bash
npm run start
```

To **build** for production run:
```bash
npm run build
```
which will generate the necessary files for the control panel into the `./build` folder.

0 comments on commit 3fa2f1f

Please sign in to comment.