nanakshahi 0.3 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -11
  3. data/lib/nanakshahi/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6d6f1860020f496e46759bfbf773e907511eef5349cd1386fd305473bbfca0c2
4
- data.tar.gz: 348c4f90184c307f2ba3d7eba2867dbdd089288285eb5fd2761f42a6be631096
3
+ metadata.gz: a0463259484c7c4dc42a9cca224c2aa0f92c973bf15cface244fbd8737d56428
4
+ data.tar.gz: 156097925d4f56d5eaf3e3cc7e51fc57f5f14168b8eca053b0aac4418fdf3d48
5
5
  SHA512:
6
- metadata.gz: e9c95621d31dc09b969aa75a7d32e843094e13388e2ef66d8f790065621958abc0899456b26d62c2fae2f8ccaa4ab63a3bc93a7d3ca5f86cf72e80d101b12f7a
7
- data.tar.gz: ec63fb3edd2a44f293943e2eb754872483282e2eee3a80dc67e2990528959f527ab77a94d6836d4ff4b9b090e72911110aa0a9c7f58a372731946748fae6e98b
6
+ metadata.gz: 7615dbb96309c2aa058fdf5659c32d288951014662c286acdd51d5eb1f01833d13a16dae366d9d4fcf837bc6bbea5383d2adc3fce39f4121e5e7530066ebdd7f
7
+ data.tar.gz: 81b05d9eabfcedaff95c2677f5aa545ed2c25ccb8643cc3e0fd4f129ae2a4903a9630542b5204ca234414a944b231242794e937f6ce2daafcb905b4e66b675be
data/README.md CHANGED
@@ -37,21 +37,19 @@ require 'nanakshahi'
37
37
 
38
38
  ```ruby
39
39
  date = Nanakshahi.new # Creates an object with 1 Chet, Nanakshahi
40
- date = Nanakshahi.new(550)
41
- date = Nanakshahi.new(550, 10)
42
- date = Nanakshahi.new(550, 10, 5)
40
+ date = Nanakshahi.new(553)
41
+ date = Nanakshahi.new(553, 7)
42
+ date = Nanakshahi.new(550, 7, 6)
43
+ date = Nanakshahi.today
43
44
  ```
44
45
 
45
46
  ### Using common calendar/gregorian date
46
47
 
47
48
  ```ruby
48
- date = Nanakshahi.from_gregorian(2019,1,8)
49
- ```
50
-
51
- ### Nanakshahi date today
52
-
53
- ```ruby
54
- date = Nanakshahi.today
49
+ date = Nanakshahi.from_gregorian(2021,9,21)
50
+ => #<Nanakshahi:0x00007fbec18410e8 @day=7, @month=7, @year=553>
51
+ ndate = date.to_gregorian
52
+ => #<Date: 2021-09-21 ((2459479j,0s,0n),+0s,2299161j)>
55
53
  ```
56
54
 
57
55
  ### Is it a gurpurab?
@@ -77,6 +75,8 @@ p date.to_nanakshahi
77
75
 
78
76
  ### Printing Nanakshahi date
79
77
 
78
+ #### Roman
79
+
80
80
  `to_s` method prints Nanakshahi date either Nanakshahi or Dhundkaal suffix (pre-Guru Nanak). To take care of 0 year correction, like gregorian, it is assumed that 1 Dhundkaal precedes 1 Nanakshahi when printed with suffix.
81
81
 
82
82
  ```ruby
@@ -84,7 +84,7 @@ date = Nanakshahi.new(1400-2-18)
84
84
  puts date
85
85
  ```
86
86
 
87
- ### To Gurmukhi
87
+ #### Gurmukhi
88
88
 
89
89
  `to_gurmukhi` prints the date in Gurmukhi characters, complete with Gurmukhi numerals.
90
90
 
@@ -93,6 +93,26 @@ date = Nanakshahi.new(1400-2-18)
93
93
  puts date.to_gurmukhi
94
94
  ```
95
95
 
96
+ #### Shahmukhi
97
+
98
+ `to_shahmukhi` prints the date in Shahmukhi characters, complete with Shahmukhi numerals.
99
+
100
+ ```ruby
101
+ date = Nanakshahi.today
102
+ puts date.to_shahmukhi
103
+ ```
104
+
105
+ ### Recommendations
106
+ The following was not part of the seminal work by Pal Singh Purewal, but constituted part of recommendations in our paper [Building an Open-Source Nanakshahi Calendar: Identity and a Spiritual and Computational Journey(Singh et al., 2020)](https://sikhresearchjournal.org/building-an-open-source-nanakshahi-calendar-identity-and-a-spiritual-and-computational-journey-by-arvinder-singh-amandeep-singh-amarpreet-singh-harvinder-singh-parm-singh/)
107
+
108
+ ### Dhundkaal - The era of the fog
109
+
110
+ ```ruby
111
+ date = Nanakshahi.from_gregorian(1468,1,1)
112
+ date.to_s
113
+ => "19 Poh, 2 Dhundkaal"
114
+ ```
115
+
96
116
  For a complete list of all the methods, check out [the documentation](https://www.rubydoc.info/gems/nanakshahi).
97
117
 
98
118
  ## Contributing
@@ -1,3 +1,3 @@
1
1
  class Nanakshahi
2
- VERSION = "0.3"
2
+ VERSION = "0.3.1"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: nanakshahi
3
3
  version: !ruby/object:Gem::Version
4
- version: '0.3'
4
+ version: 0.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Arvinder Singh