README.md draft.

This commit is contained in:
Alexey Skobkin 2016-03-22 23:21:21 +03:00
parent d8646c21a2
commit efc59f1a99

23
README.md Normal file
View file

@ -0,0 +1,23 @@
# README #
### What is Point Tools Crawler for? ###
Point Tools Crawler was written for dumping Point.im posts to Point Tools service.
### How to build? ###
You need Go 1.6+ installed to build this project.
```bash
git clone https://skobkin@bitbucket.org/skobkin/point-tools-crawler.git
cd point-tools-crawler
go build
```
### How to use? ###
Just run point-tools-crawler binary with its CLI parameters:
```bash
./point-tools-crawler -l your_point_login -p your_point_password -t your_point_tools_crawler_api_token
```