Yaavi 1 year ago
parent
commit
be74f44bee
2 changed files with 15 additions and 10 deletions
  1. 8 5
      README.en.md
  2. 7 5
      README.md

+ 8 - 5
README.en.md

@@ -8,7 +8,9 @@
 
 
 This project provides a set of functions for managing and querying Chinese holidays, adjusted workdays (in lieu days), regular workdays, and the 24 solar terms. By using these functions, users can easily check the status of a specified date, get holidays or workdays within a date range, and find specific workdays. Additionally, the project supports querying the dates of the 24 solar terms, helping users understand the timing of traditional Chinese solar terms.
 This project provides a set of functions for managing and querying Chinese holidays, adjusted workdays (in lieu days), regular workdays, and the 24 solar terms. By using these functions, users can easily check the status of a specified date, get holidays or workdays within a date range, and find specific workdays. Additionally, the project supports querying the dates of the 24 solar terms, helping users understand the timing of traditional Chinese solar terms.
 
 
-Supports the years 2004 to 2024, including the extended Spring Festival in 2020.
+Description:
+1. Holidays: Supports from 2004 to 2024, including the extended Spring Festival in 2020.
+2. Lunar Dates: Supports from 1900 to 2100.
 
 
 ## Quick Start
 ## Quick Start
 
 
@@ -219,10 +221,10 @@ When dealing with a leap month in the lunar calendar, one lunar date may corresp
 
 
 ```js
 ```js
 console.log(getSolarDateFromLunar('2001-03-05'))
 console.log(getSolarDateFromLunar('2001-03-05'))
-// return {date: '2001-03-29', leapMonthDate: undefined}
+// Output: {date: '2001-03-29', leapMonthDate: undefined}
 
 
 console.log(getSolarDateFromLunar('2001-04-05'))
 console.log(getSolarDateFromLunar('2001-04-05'))
-// return {date: '2001-04-27', leapMonthDate: '2001-05-27'}
+// Output: {date: '2001-04-27', leapMonthDate: '2001-05-27'}
 ```
 ```
 
 
 ## Contributing
 ## Contributing
@@ -234,6 +236,7 @@ console.log(getSolarDateFromLunar('2001-04-05'))
 5. Run the command `npm run generate` to automatically generate the [holiday constants file](src/holidays/constants.ts);
 5. Run the command `npm run generate` to automatically generate the [holiday constants file](src/holidays/constants.ts);
 6. Submit a PR.
 6. Submit a PR.
 
 
-## Acknowledgments
+## Acknowledgements
 
 
-This project references the `Python` version of the [LKI/chinese-calendar](https://github.com/LKI/chinese-calendar) open-source project.
+1. Lunar calendar data is sourced from the [Bigkoo/Android-PickerView](https://github.com/Bigkoo/Android-PickerView) project.
+2. Chinese holiday data generation references the `Python` version of the [LKI/chinese-calendar](https://github.com/LKI/chinese-calendar) project.

+ 7 - 5
README.md

@@ -6,7 +6,9 @@
 
 
 本项目提供了一系列用于管理和查询中国节假日、调休日、工作日及二十四节气的函数。通过使用这些函数,用户可以方便地检查指定日期的状态,获取日期范围内的节假日或工作日,并查找特定的工作日。此外,项目还支持查询二十四节气的日期,帮助用户了解中国传统节气的时间安排。
 本项目提供了一系列用于管理和查询中国节假日、调休日、工作日及二十四节气的函数。通过使用这些函数,用户可以方便地检查指定日期的状态,获取日期范围内的节假日或工作日,并查找特定的工作日。此外,项目还支持查询二十四节气的日期,帮助用户了解中国传统节气的时间安排。
 
 
-支持 2004年 至 2024年,包括 2020年 的春节延长。
+说明:
+1. 节假日:支持 2004年 至 2024年,包括 2020年 的春节延长。
+2. 农历日:支持 1900年 至 2100年。
 
 
 ## 快速开始
 ## 快速开始
 
 
@@ -186,7 +188,6 @@ console.log(getLunarDate('2097-08-07'))
 
 
 // 2057-9-28
 // 2057-9-28
 console.log(getLunarDate('2057-09-28'))
 console.log(getLunarDate('2057-09-28'))
-// 输出:
 // {
 // {
 //   date: "2057-09-28",
 //   date: "2057-09-28",
 //   lunarYear: 2057,
 //   lunarYear: 2057,
@@ -219,10 +220,10 @@ console.log(getLunarDatesInRange('2001-05-21', '2001-05-26'))
 
 
 ```js
 ```js
 console.log(getSolarDateFromLunar('2001-03-05'))
 console.log(getSolarDateFromLunar('2001-03-05'))
-// return {date: '2001-03-29', leapMonthDate: undefined}
+// {date: '2001-03-29', leapMonthDate: undefined}
 
 
 console.log(getSolarDateFromLunar('2001-04-05'))
 console.log(getSolarDateFromLunar('2001-04-05'))
-// return {date: '2001-04-27', leapMonthDate: '2001-05-27'}
+// {date: '2001-04-27', leapMonthDate: '2001-05-27'}
 ```
 ```
 
 
 ## 贡献代码
 ## 贡献代码
@@ -236,4 +237,5 @@ console.log(getSolarDateFromLunar('2001-04-05'))
 
 
 ## 致谢
 ## 致谢
 
 
-本项目参考了 `Python` 版本的 [LKI/chinese-calendar](https://github.com/LKI/chinese-calendar) 开源项目。
+1. 农历数据来自于 [Bigkoo/Android-PickerView](https://github.com/Bigkoo/Android-PickerView) 项目。
+2. 中国节假日数据生成参考了 `Python` 版本的 [LKI/chinese-calendar](https://github.com/LKI/chinese-calendar) 项目。