western-signs 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -6
  2. package/package.json +25 -24
package/README.md CHANGED
@@ -2,12 +2,17 @@
2
2
 
3
3
  Simple interface for [western astrological](https://en.wikipedia.org/wiki/Western_astrology) signs.
4
4
 
5
- ![NPM Version](https://img.shields.io/npm/v/western-signs)
6
- ![GitHub License](https://img.shields.io/github/license/marcmarine/western-signs)
5
+ [![NPM Version](https://img.shields.io/npm/v/western-signs)](https://www.npmjs.com/package/western-signs)
6
+ [![GitHub License](https://img.shields.io/github/license/marcmarine/western-signs)](LICENSE)
7
+
8
+ The **Western Signs** library provides detailed information about each astrological sign, including its `name`, `element`, `modality`, `rulingPlanet` and `glyph`, among other things. Additionally, you can specify the language for translations.
9
+
10
+ <details close>
11
+ <summary>WordArt</summary>
7
12
 
8
13
  ![West Art](https://github.com/marcmarine/western-signs/raw/main/WestArt.gif)
9
14
 
10
- The **Western Signs** library provides detailed information about each astrological sign, including its `name`, `element`, `modality`, `rulingPlanet` and `glyph`, among other things. Additionally, you can specify the language for translations.
15
+ </details>
11
16
 
12
17
  ## Installation
13
18
 
@@ -35,13 +40,20 @@ It should returns an object with the following properties:
35
40
 
36
41
  ```js
37
42
  {
38
- name: 'Taurus',
43
+ bodyPart: 'Throat',
44
+ character: 'Bull',
39
45
  element: 'Earth',
46
+ endDate: 2020-05-20T22:00:00.000Z,
47
+ glyph: '♉',
40
48
  modality: 'Fixed',
49
+ name: 'Taurus',
50
+ number: 2,
51
+ pole: 'Negative',
41
52
  rulingPlanet: 'Venus',
42
- glyph: '♉'
43
- [...]
53
+ season: 'Spring',
54
+ startDate: 2020-04-20T22:00:00.000Z
44
55
  }
56
+
45
57
  ```
46
58
 
47
59
  ## API Reference
package/package.json CHANGED
@@ -1,44 +1,45 @@
1
1
  {
2
2
  "name": "western-signs",
3
- "version": "1.4.0",
4
- "license": "MIT",
5
- "description": "Simple interface for western astrological signs.",
3
+ "version": "1.4.1",
6
4
  "author": "Marc Mariné <shenobi@gmail.com>",
7
- "homepage": "https://github.com/marcmarine/western-signs",
8
- "bugs": "https://github.com/marcmarine/western-signs/issues/new",
9
5
  "repository": {
10
6
  "type": "git",
11
7
  "url": "https://github.com/marcmarine/western-signs.git"
12
8
  },
13
- "keywords": [
14
- "astrology",
15
- "zodiac",
16
- "horoscope",
17
- "western-signs"
18
- ],
19
- "type": "module",
9
+ "devDependencies": {
10
+ "@semantic-release/changelog": "^6.0.3",
11
+ "@semantic-release/git": "^10.0.1",
12
+ "@types/bun": "latest",
13
+ "iso-639-1": "^3.1.2",
14
+ "semantic-release": "^24.0.0",
15
+ "typedoc": "0.27.5",
16
+ "upgradeps": "^2.0.6",
17
+ "varvara-typedoc-theme": "^0.1.3"
18
+ },
19
+ "peerDependencies": {
20
+ "typescript": "^5.5.3"
21
+ },
20
22
  "exports": {
21
23
  ".": "./dist/index.js"
22
24
  },
25
+ "bugs": "https://github.com/marcmarine/western-signs/issues/new",
26
+ "description": "Simple interface for western astrological signs.",
23
27
  "files": [
24
28
  "dist"
25
29
  ],
30
+ "homepage": "https://github.com/marcmarine/western-signs",
31
+ "keywords": [
32
+ "astrology",
33
+ "zodiac",
34
+ "horoscope",
35
+ "western-signs"
36
+ ],
37
+ "license": "MIT",
26
38
  "publishConfig": {
27
39
  "access": "public"
28
40
  },
29
41
  "scripts": {
30
42
  "build": "bun build.ts"
31
43
  },
32
- "devDependencies": {
33
- "@semantic-release/changelog": "^6.0.3",
34
- "@semantic-release/git": "^10.0.1",
35
- "@types/bun": "latest",
36
- "iso-639-1": "^3.1.2",
37
- "semantic-release": "^24.0.0",
38
- "typedoc": "^0.26.8",
39
- "upgradeps": "^2.0.6"
40
- },
41
- "peerDependencies": {
42
- "typescript": "^5.5.3"
43
- }
44
+ "type": "module"
44
45
  }