Skip to content

Commit

Permalink
fix README #7 #8
Browse files Browse the repository at this point in the history
  • Loading branch information
gongo committed Nov 30, 2011
1 parent 895de37 commit 6e57502
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 7 deletions.
24 changes: 21 additions & 3 deletions README.ja.org
Expand Up @@ -15,15 +15,33 @@
もしくは、以下を実行してください
: M-x auto-install-from-url RET https://raw.github.com/hackers/org-redmine/master/org-redmine.el
** 設定
*** URL や API Key
*** URL
: ;; 対象の Redmine の URL を設定します
: ;; 例. Redmine Project
: (setq org-redmine-uri "http://www.redmine.org")
: ;; 例. Ruby Project
: (setq org-redmine-uri "http://redmine.ruby-lang.org")

: ;; オプションとして、REST API Key が設定可能です。デフォルトは nil になっています
: (setq org-redmine-api-key "xxxxxxxxxxxxxxxxxxxx")
*** 認証 (必須ではない)
認証設定は3つあります。優先度の高い順に紹介していきます。

すべて設定されていても、優先度の高いものだけ適用されます。

1. API Key

REST API Key が設定可能です。デフォルトは nil になっています
: (setq org-redmine-api-key "xxxxxxxxxxxxxxxxxxxx")

2. ユーザ/パスワード認証

ログインに用いるユーザ及びパスワードを使って認証を行います。
: (setq org-redmine-auth-username "gongo")
: (setq org-redmine-auth-password "secret")

3. netrc 認証
=$HOME/.netrc= の使って認証を行うかどうかを設定します。
: (setq org-redmine-auth-netrc-use t) ;; デフォルトは nil

*** テンプレートに用いるシーケンス一覧
| %-sequence | mean |
|------------+--------------------------------------|
Expand Down
24 changes: 20 additions & 4 deletions README.org
Expand Up @@ -3,9 +3,11 @@
** Install
*** Using git
1. You can clone the git repository

: git clone git://github.com/hackers/org-redmine.git

2. Then add this to your ~/.emacs.el

: (add-to-list 'load-path "/path/to/org-redmine/")
: (require 'org-redmine)

Expand All @@ -16,15 +18,29 @@
: ;; Or run
: ;; M-x auto-install-from-url RET https://raw.github.com/hackers/org-redmine/master/org-redmine.el
** Setup
*** URL and key
*** URL (Required)
: ;; Target Redmine URI
: ;; eg. Redmine Project
: (setq org-redmine-uri "http://www.redmine.org")
: ;; eg. Ruby Project
: (setq org-redmine-uri "http://redmine.ruby-lang.org")
:
: ;; REST API Key (optional). default nil
: (setq org-redmine-api-key "xxxxxxxxxxxxxxxxxxxx")
*** Authentication (Optional)
Presented in order of highest priority setting.

1. REST API Key

: (setq org-redmine-api-key "xxxxxxxxxxxxxxxxxxxx") ;; nil default

2. username/password

: (setq org-redmine-auth-username "gongo")
: (setq org-redmine-auth-password "secret")

3. use =$HOME/.netrc=

: ;; if t, read $HOME/.netrc
: (setq org-redmine-auth-netrc-use t) ;; nil default

*** Template Sequences
| %-sequence | mean |
|------------+--------------------|
Expand Down

0 comments on commit 6e57502

Please sign in to comment.