README.md in abak-flow-0.2.1 vs README.md in abak-flow-0.2.2

- old
+ new

@@ -23,20 +23,37 @@ # Установка $ gem install abak-flow $ git config --global alias.request '!request' - $ git config --global github.user AwesomeCoder - $ git config --global github.token 0123456789yourf0123456789token - $ git remote add upstream git://github.com/anonimus/example.git + $ git config --global abak.apiuser your_github_mail@gmail.com + $ git config --global abak.apitoken 0123456789yourf0123456789token + $ git remote add upstream git://github.com/github_user_name/project.git + +### А если я использую прокси, как быть? + $ git config --global abak.proxy http://my-proxy.com:3129 + +Далее по приоритету идут переменные окружения. Сначала **http_proxy**, затем **HTTP_PROXY** +Т.е если вы используете переменные окружения, то просто не указывайте прокси в конфиге + +--- + +**Заметьте:** В конфиге git, значением *abak.apiuser* должен являться тот email адрес, под которым вы заходите на github + **Обратите внимание:** В данном контексте под **upstream** подразумевается адрес репозитория в который будут оформляться pull request. А репозиторием **origin** будет являться ваш форк # С чего начать? - $ git request --help + $ git request readycheck +или + + $ git request help + +**Примечание:** Вообще-то все комманды поддерживают опцию *--help*, но вот именно *git request --help* успевает перехватиться самим git и он конечно неодумевает как ему показать хэлп по внешней комманде + # Примеры использования ### Самый простой способ начать новую задачу: $ git checkout develop $ git request feature 'TASK-001' @@ -80,13 +97,13 @@ Или же так $ git co feature/TASK-001 $ git request done --local -### Маленькие хитрости +## Маленькие хитрости Если сразу правильно именовать ветки, т.е ветку с задачей создавать с именем, такого формата TASK-001, то, в описание pull request автоматически вставится ссылка на задачу в jira, а в имя pull request сразу вставится название, состоящее из имени задачи, т.е TASK-001 -### А помощь? +## А помощь? Многие команды имеют какие-то дополнительные опции. Но они нужны только в экзотических случаях. Но при любом раскладе подсказку и тонкий намек всегда можно получить воспользовавших такой командой: $ git request done --help # В заключении \ No newline at end of file