README.md
This commit is contained in:
parent
321a525e07
commit
c5d5a6ac72
1 changed files with 19 additions and 1 deletions
20
README.md
20
README.md
|
@ -1 +1,19 @@
|
||||||
# Crawing && Serving #
|
# Crawing & Serving #
|
||||||
|
|
||||||
|
The crawler is a simple crawler that crawls the web and stores the results in a database and assets in a file system. The server is a simple server that serves the results of the crawler.
|
||||||
|
|
||||||
|
|
||||||
|
## Crawler ##
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Usage ###
|
||||||
|
|
||||||
|
Post a JSON object to the crawler with the following format:
|
||||||
|
|
||||||
|
`domain.com/crawl`
|
||||||
|
{
|
||||||
|
"url": "http://www.example.com",
|
||||||
|
}
|
||||||
|
|
||||||
|
The crawler will then crawl the given url and store the results in a database and assets in a file system.
|
Loading…
Reference in a new issue