Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chaos358 authored Apr 21, 2018
1 parent abc2e7e commit 34a8dd1
Showing 1 changed file with 0 additions and 42 deletions.
42 changes: 0 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,45 +23,3 @@ I make a lot of web apps using react and angular. I know there are dev tools tha
This extension works by taking some start URL, crawling that page for more links, and then recursively crawling those pages for more links. Once all found links have been checked, the extension generates a sitemap file. Of course this approach assumes website is properly using anchor tags to connect its contents. The extension also checks HTTP headers and excludes pages that return failing response codes.

This implementation is not practical if website contains tens of thousands of pages. It can however, crawl a few thousand entries in a reasonable amount of time. Also note while the sitemap is being generated, you may continue regular browsing at the same time. The generator will run in its own window.

----
## Development

Source documentation is available here: https://pikkumyy.github.io/sitemap-generator

This is a simplified diagram showing how the process works

<img src="https://raw.githubusercontent.com/pikkumyy/sitemap-generator/master/system.png" alt='system' />

#### Requirements

To build and run this program locally you will need the following:

- Node.js
- [yarn](https://yarnpkg.com/en/) (_recommended_)
- Web IDE of your choice
- Chrome browser

### Build Instructions / Basic Usage

1) Clone the repo
```
https://github.com/pikkumyy/sitemap-generator.git
```
2) Install dependecies by running `yarn` or `npm install`

3) Build the extension `yarn dev` or `npm run dev`

#### Full List of CLI options

see `package.json` scripts

#### Debug Instructions

Using Chrome browser:

1) Go to `chrome://extensions`. Make sure you have developer mode enabled.

2) Click `Load unpacked extension...`

3) Choose the `dist/` directory.

0 comments on commit 34a8dd1

Please sign in to comment.