Skip to content

Commit

Permalink
Added ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
AjaniBilby committed Apr 8, 2017
1 parent 4422f79 commit eb1fad2
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#Wiki Web

Is a electron based app of which allows a user to create a connection web between two articles.

## How it works
First input is the start page. It will go to the wikipedia page with that title and gather every link on that page, then it will go to every link and get all links on those pages. It does this until it finds one link to the target page, then it will not add anymore search terms, and will finish all of it's current queue, to see if there are multiple links to the desired page.

## Setup
You will need to install npm
Then open a command prompt in the director and execute ```npm run start```
**Note:** All data your computer loads will be store ```'./data/'``` folder, to allow for faster searches the more a user users it.

## Controls
**Rest / Refresh:** CTRL + R
**Fullscreen:** F12
**Zoom In:** CTRL + =
**Zoom Out:** CTRL + -
**Save:** CTRL + S

## Build
You can also build to run as an application for;
Windows: ```npm run build-win```
Linux: ```npm run build-linux```
Mac: ```npm run build-linux```

0 comments on commit eb1fad2

Please sign in to comment.