NSDate+TimeAgo 项目技术文档

1. 安装指南

1.1 使用 Cocoapods 安装

1. 在 Podfile 文件中添加以下内容：

   pod 'NSDate+TimeAgo'
   

2. 运行以下命令安装依赖：

   pod install
   

1.2 手动安装

1. 下载项目文件。
2. 将 NSDate+TimeAgo.h 和 NSDate+TimeAgo.m 文件添加到你的 Xcode 项目中。

2. 项目的使用说明

2.1 导入头文件

在需要使用 NSDate+TimeAgo 功能的文件中导入头文件：

#import "NSDate+TimeAgo.h"

2.2 使用方法

2.2.1 timeAgo 方法

该方法返回一个字符串，表示从当前时间到指定日期的相对时间。例如：

NSDate *date = [[NSDate alloc] initWithTimeIntervalSince1970:0];
NSString *ago = [date timeAgo];
NSLog(@"Output is: \"%@\"", ago);
// 输出: "41 years ago"

2.2.2 dateTimeAgo 方法

该方法返回一个更精确的时间字符串，格式为 "{value} {unit} ago"。例如：

NSString *ago = [date dateTimeAgo];
NSLog(@"Output is: \"%@\"", ago);
// 输出: "41 years ago"

2.2.3 dateTimeUntilNow 方法

该方法返回一个更自然的时间字符串，例如 "yesterday"、"this morning" 等。例如：

NSString *ago = [date dateTimeUntilNow];
NSLog(@"Output is: \"%@\"", ago);
// 输出: "41 years ago"

3. 项目API使用文档

3.1 timeAgo

• 描述: 返回一个字符串，表示从当前时间到指定日期的相对时间。
• 返回值: NSString 类型，表示相对时间。

3.2 dateTimeAgo

• 描述: 返回一个更精确的时间字符串，格式为 "{value} {unit} ago"。
• 返回值: NSString 类型，表示相对时间。

3.3 dateTimeUntilNow

• 描述: 返回一个更自然的时间字符串，例如 "yesterday"、"this morning" 等。
• 返回值: NSString 类型，表示相对时间。

4. 项目安装方式

4.1 使用 Cocoapods 安装

1. 在 Podfile 文件中添加以下内容：

   pod 'NSDate+TimeAgo'
   

2. 运行以下命令安装依赖：

   pod install
   

4.2 手动安装

1. 下载项目文件。
2. 将 NSDate+TimeAgo.h 和 NSDate+TimeAgo.m 文件添加到你的 Xcode 项目中。

5. 未来发展方向

1. 添加自定义选项（例如，是否报告秒数或仅显示“一分钟前”）。
2. 添加字符串自定义功能。
3. 增加更多语言的本地化支持。
4. 使 dateTimeUntilNow 更精确，例如使用“上周五”、“上周一”等。
5. 其他改进。

6. 许可证

该项目基于 ISC 许可证发布，类似于 2-clause BSD 许可证。

7. 贡献者

• Christopher Pickslay
• Ramon Torres
• Dennis Zhuang
• Mozart Petter
• Stéphane Gerardot
• Marco Sanson
• Almas Adilbek
• Mallox51
• Tieme van Veen
• Árpád Goretity
• Anajavi
• Tonydyb
• Vinhnx
• Ronail
• SorinAntohi
• spookd
• Barrett Jacobsen
• Dmitry Shmidt
• Martins Rudens
• Osman Saral
• analogstyle
• Flavio Caetano
• kolarski
• Vladimir Kofman
• Viraf Sarkari
• Vasyl Skrypii
• Maggi Trymbill
• Erid Bardhaj
• Joan Biscarri
• Gantulga
• ali-ehsan
• Zonily Jame Pesquera