microsoft
/
ghcrawler-cli
зеркало из https://github.com/microsoft/ghcrawler-cli.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

make a few instructions in the README more clear

This commit is contained in:
Dani Gellis 2019-12-12 18:09:34 -08:00
Родитель d6a2375c12
Коммит 776d883026
1 изменённых файлов: 3 добавлений и 3 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

6
README.md
Просмотреть файл

@ -7,7 +7,7 @@
The `cc` utility is in the `bin` directory of this repo. It can be run interactively or as a single command processor. The general format of using the command line is The `cc` utility is in the `bin` directory of this repo. It can be run interactively or as a single command processor. The general format of using the command line is
``` ```
node cc [options] [command] node bin/cc [options] [command]
``` ```
where the available options are: where the available options are:
@ -26,7 +26,7 @@ The available commands are:
`queue <requests...>` -- Queues the given requests for processing. The requests parameter is a list of GitHub "${org}" and/or "${org}/${repo}" and/or "users/${user}" names. `queue <requests...>` -- Queues the given requests for processing. The requests parameter is a list of GitHub "${org}" and/or "${org}/${repo}" and/or "users/${user}" names.
`orgs <org orgs...>` -- Set the crawler's to traverse only the GitHub orgs named in the given list. `orgs <org orgs...>` -- Set the crawlers to traverse only the GitHub orgs named in the given list.
`config` -- Dumps the crawler service's configuration to the console. `config` -- Dumps the crawler service's configuration to the console.
@ -35,7 +35,7 @@ The available commands are:
A typical sequence shown in the snippet below configures the crawler with a set of tokens, configures the org filter set and then queues and starts the processing of the org. A typical sequence shown in the snippet below configures the crawler with a set of tokens, configures the org filter set and then queues and starts the processing of the org.
``` ```
> node bin/cc > node bin/cc -i
http://localhost:3000> tokens 43984b2344ca575d0f0e097efd97#public 972bbdfe098098fa9ce082309#admin http://localhost:3000> tokens 43984b2344ca575d0f0e097efd97#public 972bbdfe098098fa9ce082309#admin
http://localhost:3000> orgs contoso-d http://localhost:3000> orgs contoso-d
http://localhost:3000> queue contoso-d http://localhost:3000> queue contoso-d