docs: update readme

2020-06-25 14:36:59 +08:00 · 2020-06-25 14:36:59 +08:00 · fe6c77f773
parent 55bfd89fa9
commit fe6c77f773
1 changed files with 75 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,4 +1,78 @@
 # HackBrowserData

-export your browser data, support Safari and Chrome.
+一款支持全平台（Windows | MacOS | Linux）的浏览器数据（Password | History | Bookmark | Cookie）导出工具

+
+
+### 安装编译
+
+1. 直接下载编译好的[二进制文件](https://github.com/moonD4rk/HackBrowserData/releases)
+
+2. 手动编译
+
+   ```
+   git clone https://github.com/moonD4rk/HackBrowserData
+   
+   cd HackBrowserData && go mod tidy
+   ```
+
+### 运行
+
+```bash
+```bash
+./hack-browser-data -h
+NAME:
+   hack-browser-data - export passwords/cookies/history/bookmarks from browser
+
+VERSION:
+   0.1.0
+
+COMMANDS:
+   help, h  Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --browser value, -b value      browser name, all|chrome|safari (default: "all")
+   --results-dir value, -d value  export dir (default: "results")
+   --format value, -f value       result format, csv|json (default: "csv")
+   --export-data value, -e value  all|password|cookie|history|bookmark (default: "all")
+   --help, -h                     show help (default: false)
+   --version, -v                  print the version (default: false)
+```
+
+
+
+### 目前支持平台
+
+| Browser        | Password | Cookie | Bookmark | History |
+| :------------- | :------: | :----: | :------: | :-----: |
+| Windows Chrome |    ✔     |   ✔    |    ✔     |    ✔    |
+| MacOS Chrome   |    ✔     |   ✔    |    ✔     |    ✔    |
+| Linux Chrome   |    ✖     |   ✖    |    ✖     |    ✖    |
+| Windows Edge   |    ✖     |   ✖    |    ✖     |    ✖    |
+| MacOS Edge     |    ✖     |   ✖    |    ✖     |    ✖    |
+| Linux Edge     |    ✖     |   ✖    |    ✖     |    ✖    |
+| MacOS Safari   |    ✖     |   ✖    |    ✖     |    ✖    |
+| MacOS Keychain |    ✖     |        |          |         |
+
+### Todo List
+
+based this two list
+
+[Desktop Browser Market Share Worldwide](https://gs.statcounter.com/browser-market-share/desktop/worldwide)
+
+| Chrome | Safari | Firefox | Edge Legacy | IE |  Other  |
+| :------:| :------: | :----: | :------: | :-----: | :--: |
+| 68.33% |    9.4% | 8.91% |   4.41% |    3%    |  3%  |
+
+[Desktop Browser Market Share China](https://gs.statcounter.com/browser-market-share/desktop/china)
+
+| Chrome | 360 Safe | Firefox | QQ Browser |  IE   | Sogou Explorer |
+| :----- | :------: | :-----: | :--------: | :---: | :------------: |
+| 68.33% |   9.4%   |  8.91%  |   4.41%    | 5.65% |     4.74%      |
+
+I woulf support those browser in the future
+1. Firefox
+2. Safari
+3. Edge
+4. 360 browser
+5. IE