Skip to content

Commit de3930f

Browse files
committed
Small adjustments to README. Sync PACKAGE file with latest README info.
1 parent a50631c commit de3930f

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Creates a ULID from an existing byte array.
112112
- `Ulid.New(Guid guid)`\
113113
Create from existing `Guid`.
114114

115-
### Checking validity
115+
### Checking Validity
116116

117117
- `Ulid.IsValid(string ulidString)`\
118118
Validates if the given string is a valid ULID.
@@ -152,7 +152,7 @@ Converts the ULID to a `Guid`.
152152
- `.ToString(string? format = null, IFormatProvider? formatProvider = null)`\
153153
Converts the ULID to a canonical string representation. Format arguments are ignored.
154154

155-
### Comparison operators
155+
### Comparison Operators
156156

157157
- Supports all comparison operators:\
158158
`==`, `!=`, `<`, `<=`, `>`, `>=`.

src/ByteAether.Ulid/PACKAGE.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,15 @@ Creates a ULID from an existing byte array.
8383
- `Ulid.New(Guid guid)`\
8484
Create from existing `Guid`.
8585

86+
### Checking Validity
87+
88+
- `Ulid.IsValid(string ulidString)`\
89+
Validates if the given string is a valid ULID.
90+
- `Ulid.IsValid(ReadOnlySpan<char> ulidString)`\
91+
Validates if the given span of characters is a valid ULID.
92+
- `Ulid.IsValid(ReadOnlySpan<byte> ulidBytes)`\
93+
Validates if the given byte array represents a valid ULID.
94+
8695
### Parsing
8796

8897
- `Ulid.Parse(ReadOnlySpan<char> chars, IFormatProvider? provider = null)`\
@@ -114,7 +123,7 @@ Converts the ULID to a `Guid`.
114123
- `.ToString(string? format = null, IFormatProvider? formatProvider = null)`\
115124
Converts the ULID to a canonical string representation. Format arguments are ignored.
116125

117-
### Comparison operators
126+
### Comparison Operators
118127

119128
- Supports all comparison operators:\
120129
`==`, `!=`, `<`, `<=`, `>`, `>=`.
@@ -132,6 +141,10 @@ Supports seamless integration as a route or query parameter with built-in `TypeC
132141

133142
Includes a `JsonConverter` for easy serialization and deserialization.
134143

144+
### Other Libraries
145+
146+
Check out [README in GitHub repository](https://github.com/ByteAether/Ulid/blob/main/README.md) for examples to integrate with Entity Framework Core, Dapper, MessagePack and Newtonsoft.Json.
147+
135148
## Prior Art
136149

137150
Much of this implementation is either based on or inspired by existing works. This library is standing on the shoulders of giants.

0 commit comments

Comments
 (0)