Skip to content

Commit

Permalink
Fixed typos and some language in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
melvitax committed Mar 3, 2021
1 parent 7dc5945 commit c18b957
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
16 changes: 8 additions & 8 deletions DateHelper.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks @loader_path/Frameworks";
MACOSX_DEPLOYMENT_TARGET = 10.14;
MARKETING_VERSION = 4.5.0;
MARKETING_VERSION = 4.5.1;
MTL_ENABLE_DEBUG_INFO = YES;
"MTL_ENABLE_DEBUG_INFO[arch=*]" = YES;
PRODUCT_BUNDLE_IDENTIFIER = "com.allforces.DateHelper-macOS";
Expand Down Expand Up @@ -401,7 +401,7 @@
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks @loader_path/Frameworks";
MACOSX_DEPLOYMENT_TARGET = 10.14;
MARKETING_VERSION = 4.5.0;
MARKETING_VERSION = 4.5.1;
MTL_ENABLE_DEBUG_INFO = NO;
PRODUCT_BUNDLE_IDENTIFIER = "com.allforces.DateHelper-macOS";
PRODUCT_NAME = DateHelper;
Expand Down Expand Up @@ -547,7 +547,7 @@
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
IPHONEOS_DEPLOYMENT_TARGET = 11.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
MARKETING_VERSION = 4.5.0;
MARKETING_VERSION = 4.5.1;
MTL_ENABLE_DEBUG_INFO = YES;
PRODUCT_BUNDLE_IDENTIFIER = "com.allforces.DateHelper-IOS";
PRODUCT_NAME = DateHelper;
Expand Down Expand Up @@ -584,7 +584,7 @@
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
IPHONEOS_DEPLOYMENT_TARGET = 11.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
MARKETING_VERSION = 4.5.0;
MARKETING_VERSION = 4.5.1;
MTL_ENABLE_DEBUG_INFO = NO;
PRODUCT_BUNDLE_IDENTIFIER = "com.allforces.DateHelper-IOS";
PRODUCT_NAME = DateHelper;
Expand Down Expand Up @@ -617,7 +617,7 @@
INFOPLIST_FILE = "$(SRCROOT)/Sources/Info.plist";
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
MARKETING_VERSION = 4.5.0;
MARKETING_VERSION = 4.5.1;
MTL_ENABLE_DEBUG_INFO = YES;
PRODUCT_BUNDLE_IDENTIFIER = "com.allforces.DateHelper-tvOS";
PRODUCT_NAME = DateHelper;
Expand Down Expand Up @@ -655,7 +655,7 @@
INFOPLIST_FILE = "$(SRCROOT)/Sources/Info.plist";
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
MARKETING_VERSION = 4.5.0;
MARKETING_VERSION = 4.5.1;
MTL_ENABLE_DEBUG_INFO = NO;
PRODUCT_BUNDLE_IDENTIFIER = "com.allforces.DateHelper-tvOS";
PRODUCT_NAME = DateHelper;
Expand Down Expand Up @@ -691,7 +691,7 @@
INFOPLIST_FILE = "$(SRCROOT)/Sources/Info.plist";
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
MARKETING_VERSION = 4.5.0;
MARKETING_VERSION = 4.5.1;
MTL_ENABLE_DEBUG_INFO = YES;
PRODUCT_BUNDLE_IDENTIFIER = "com.allforces.DateHelper-watchOS";
PRODUCT_NAME = DateHelper;
Expand Down Expand Up @@ -728,7 +728,7 @@
INFOPLIST_FILE = "$(SRCROOT)/Sources/Info.plist";
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
MARKETING_VERSION = 4.5.0;
MARKETING_VERSION = 4.5.1;
MTL_ENABLE_DEBUG_INFO = NO;
PRODUCT_BUNDLE_IDENTIFIER = "com.allforces.DateHelper-watchOS";
PRODUCT_NAME = DateHelper;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import DateHelper
/*:
# Comparing Dates
Provides a way to check a date against another common scenarios like isToday, isNextWeek, is etc.
Provides common checks like isToday or isNextWeek. It can also check against another date like isSameDay or isEarlier.
*/
let nowDate = Date()
let nextHourDate = Date().adjust(.hour, offset: 1)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import DateHelper

`init?(detectFromString string: String)`

Uses NSDataDetector to detect a date from natural language in a string. Similar to what Apple mail does on emails. This initializer is not as efficient as `fromString:format:` and should not be used in collections like lists.
Uses NSDataDetector to detect a date from natural language in a string. It works similar to how Apple Mail detects dates. This initializer is not as efficient as **fromString:format:** and should not be used in collections like lists.
*/
Date(detectFromString: "It happened on August 11 of 2009")
Date(detectFromString: "Tomorrow at 5:30 PM")
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Provides two initializers to create a date from string.

- **detectFromString:**
`init?(detectFromString string: String)`
Uses NSDataDetector to detect a date from natural language in a string. Similar to what Apple mail does on emails. This initializer is not as efficient as **fromString:format:** and should not be used in collections like lists.
Uses NSDataDetector to detect a date from natural language in a string. It works similar to how Apple Mail detects dates. This initializer is not as efficient as **fromString:format:** and should not be used in collections like lists.

```Swift
Date(detectFromString: "It happened on August 11 of 2009")
Expand Down Expand Up @@ -100,7 +100,7 @@ Date().toString(dateStyle: .full, timeStyle: .full)
```

### Compare Dates
Provides a way to check a date against another common scenarios like isToday, isNextWeek, is etc.
Provides common checks like isToday or isNextWeek. It can also check against another date like isSameDay or isEarlier.

- **Quick Checks**
Checks date against common scenarios
Expand Down Expand Up @@ -193,7 +193,7 @@ Date().since(secondDate, in: .week)
Date().since(secondDate, in: .month)
Date().since(secondDate, in: .year)
```
### Miscelanius
### Miscellaneous
**Setting the start day of the week**

```Swift
Expand Down

0 comments on commit c18b957

Please sign in to comment.