Skip to content

Commit

Permalink
Another documentation update.
Browse files Browse the repository at this point in the history
  • Loading branch information
mgriebling committed Oct 13, 2024
1 parent 7e6c6d9 commit f32052e
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 1 deletion.
23 changes: 23 additions & 0 deletions Package.resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"pins" : [
{
"identity" : "swift-docc-plugin",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-docc-plugin",
"state" : {
"revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",
"version" : "1.4.3"
}
},
{
"identity" : "swift-docc-symbolkit",
"kind" : "remoteSourceControl",
"location" : "https://github.com/swiftlang/swift-docc-symbolkit",
"state" : {
"revision" : "b45d1f2ed151d057b54504d653e0da5552844e34",
"version" : "1.0.0"
}
}
],
"version" : 2
}
1 change: 1 addition & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ let package = Package(
dependencies: [
// Dependencies declare other packages that this package depends on.
// .package(url: /* package url */, from: "1.0.0"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
],
targets: [
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,12 @@ UInt128/Int128.
This library includes Swift Package support out of the box.
Reference this git repository via XCode to install as a Package.

- Warning: This interface uses different initializers than earlier versions.

You can also manually copy over the `Sources/(U)Int128.swift` files into your project
and it should work great. This file split duplicates Apple's UInt128 and Int128
files. Note: Some common utilities are located in the Int128.swift file.
files. Note: Some common utilities are located in the `Common.swift` file which
you'll also need if copying to your project.

## Documentation

Expand Down
2 changes: 2 additions & 0 deletions Sources/UInt128/UInt128.docc/UInt128.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ These integer types are compliant with the following protocols:
11. Sendable
12. Codable

This package has passed the XCode 6 strict concurrency requirements.

### Usage
Since this library fully implements the UnsignedInteger or SignedInteger protocols,
you can use these data types just like any other native integer data type. For numbers larger
Expand Down

0 comments on commit f32052e

Please sign in to comment.