Skip to content

Commit 67f247a

Browse files
authored
docs: ✏️ Update README.md (#197)
1 parent 676588a commit 67f247a

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,77 @@
1-
[![Prekin](https://github.com/nikukyugamer/prekin/actions/workflows/config.yml/badge.svg?branch=main)](https://github.com/nikukyugamer/prekin/actions/workflows/config.yml)
2-
31
# Prekin
42

3+
[![Prekin](https://github.com/nikukyugamer/prekin/actions/workflows/config.yml/badge.svg?branch=main)](https://github.com/nikukyugamer/prekin/actions/workflows/config.yml)
4+
55
## What is Prekin?
66

77
### Naming
88

99
- `Prekin` means `PREMIUM FRIDAY`
10-
- `kin` means FRIDAY (`kin-yo-bi`) in Japanese
11-
- So `PRE`mium `KIN`-yo-bi is `Prekin`
10+
- `kin` means FRIDAY (`kin-yo-bi`) in Japanese
11+
- So `PRE`mium `KIN`-yo-bi is `Prekin`
1212

1313
### Webpage
1414

1515
- A webpage by Ministry of Economy, Trade and Industry in Japan
16-
- http://www.meti.go.jp/policy/mono_info_service/service/premium-friday/
16+
- <http://www.meti.go.jp/policy/mono_info_service/service/premium-friday/>
1717
- A webpage by Premium Friday Committee
18-
- https://premium-friday.com/
18+
- <https://web.archive.org/web/20230411145908if_/https://premium-friday.com/>
1919

2020
## Installation
2121

22-
Add this line to your application's Gemfile:
22+
Add this line to your application's `Gemfile`:
2323

2424
```ruby
2525
gem 'prekin'
2626
```
2727

2828
And then execute:
2929

30-
$ bundle
30+
```bash
31+
$ bundle
32+
```
3133

3234
Or install it yourself as:
3335

34-
$ gem install prekin
36+
```bash
37+
$ gem install prekin
38+
```
3539

3640
## Usage
3741

3842
### 1. require
43+
3944
- `require 'prekin'`
4045

4146
### 2. call
4247

4348
#### 2-1. Time class
49+
4450
- `Time.local(2020, 10, 30, 0, 0, 0).prekin? #=> true`
4551

4652
#### 2-2. Date class
53+
4754
- `Date.new(2020, 10, 30).prekin? #=> true`
4855

4956
#### 2-3. DateTime class
57+
5058
- `DateTime.new(2020, 10, 30, 0, 0, 0, '+09:00').prekin? #=> true`
5159

5260
#### 2-4. String class
61+
5362
- `'2020/10/30 00:00:00 +09:00'.prekin? #=> true`
5463

5564
#### 2-5. Next Prekin
65+
5666
- `Prekin.next #=> "2020-10-30"`
5767
- `Prekin.next('2023-12-28') #=> "2023-12-29"`
5868
- `Prekin.next('2023-12-29') #=> "2023-12-29"`
5969
- `Prekin.next('2023-12-30') #=> "2024-01-26"`
6070

6171
## Note
62-
- This gem overwrites `Time`, `Date`, `DateTime` and `String` class.
63-
- So if you use `Time`, `Date`, `DateTime` and `String` class in your code, you should be careful.
64-
65-
## Development
6672

67-
#### 1. bundle install
68-
- `bundle install`
69-
70-
#### 2. irb
71-
- `bundle exec irb`
72-
73-
#### 3. require
74-
- `require 'prekin'`
73+
- This gem overwrites `Time`, `Date`, `DateTime` and `String` class.
74+
- So if you use `Time`, `Date`, `DateTime` and `String` class in your code, you should be careful.
7575

7676
## License
7777

0 commit comments

Comments
 (0)