Skip to content
This repository was archived by the owner on Jan 16, 2025. It is now read-only.

Commit c8bd434

Browse files
author
Pegasus204
committed
add README
1 parent eeb0391 commit c8bd434

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# Ruboty::Esaba
1+
# ruboty-esaba
22

3-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruboty/esaba`. To experiment with that code, run `bin/console` for an interactive prompt.
4-
5-
TODO: Delete this and the text above, and describe your gem
3+
Slackでesa記事のURLを貼るとesabaのURLに置換してくれるRubotyプラグインです。
64

75
## Installation
86

@@ -22,14 +20,19 @@ Or install it yourself as:
2220

2321
## Usage
2422

25-
TODO: Write usage instructions here
23+
RubotyのGemfileに追加して、下記の環境変数を設定してください。
2624

27-
## Development
25+
## ENV
2826

29-
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
27+
* ESABA_URL_PREFIX: esaba URLのid以前の部分 ( `https://xxx.esaba.io/posts/` )
28+
* RUBOTY_ESABA_SLACK_TOKEN: slackチャンネル名取得用のAPIトークン
29+
* ESABA_ROOM_FILTER(option): URLの置き換えを行うSlackチャンネルをフィルタするための文言 ( `general` )
30+
31+
## Development
3032

31-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
33+
After checking out the repo, run `bin/setup` to install dependencies.
34+
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
3235

3336
## Contributing
3437

35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruboty-esaba.
38+
Bug reports and pull requests are welcome on GitHub at https://github.com/Pegasus204/ruboty-esaba.

lib/ruboty/esaba/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
module Ruboty
44
module Esaba
5-
VERSION = '0.1.1'
5+
VERSION = '0.1.2'
66
end
77
end

0 commit comments

Comments
 (0)