Skip to content

Commit 4ff41ab

Browse files
authored
Renaming followup (#81)
1 parent ca931b3 commit 4ff41ab

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ let swiftSettings: [SwiftSetting] = [
2323
]
2424

2525
let package = Package(
26-
name: "live-caller-id-lookup-example",
26+
name: "pir-service-example",
2727
products: [
2828
.executable(name: "PIRService", targets: ["PIRService"]),
2929
.executable(name: "ConstructDatabase", targets: ["ConstructDatabase"]),

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Live Caller ID Lookup Example
1+
# PIR Service Example
22

33
[Live Caller ID
44
Lookup](https://developer.apple.com/documentation/sms_and_call_reporting/getting_up-to-date_calling_and_blocking_information_for_your_app)
@@ -7,8 +7,8 @@ about a phone number for an incoming call. This allows the system to automatical
77
callers and display identity information on the incoming call screen.
88

99
<picture>
10-
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/apple/live-caller-id-lookup-example/raw/main/Sources/PIRService/PIRService.docc/Resources/overview~dark@2x.png">
11-
<img alt="Overview of the Live Caller ID Lookup" src="https://github.com/apple/live-caller-id-lookup-example/raw/main/Sources/PIRService/PIRService.docc/Resources/overview@2x.png">
10+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/apple/pir-service-example/raw/main/Sources/PIRService/PIRService.docc/Resources/overview~dark@2x.png">
11+
<img alt="Overview of the Live Caller ID Lookup" src="https://github.com/apple/pir-service-example/raw/main/Sources/PIRService/PIRService.docc/Resources/overview@2x.png">
1212
</picture>
1313

1414
This repository provides a functional server backend to test the Live Caller ID Lookup feature.
@@ -17,32 +17,32 @@ This repository provides a functional server backend to test the Live Caller ID
1717
> While functional, this is just an example service and should not be run in production.
1818
1919
## Overview
20-
Live caller ID Lookup Example provides:
21-
* [PIRService](https://swiftpackageindex.com/apple/live-caller-id-lookup-example/main/documentation/pirservice), an example service for Live Caller ID Lookup.
22-
* [PrivacyPass](https://swiftpackageindex.com/apple/live-caller-id-lookup-example/main/documentation/privacypass), an implementation of the Privacy Pass publicly verifiable tokens.
20+
PIR Service Example provides:
21+
* [PIRService](https://swiftpackageindex.com/apple/pir-service-example/main/documentation/pirservice), an example service for Live Caller ID Lookup.
22+
* [PrivacyPass](https://swiftpackageindex.com/apple/pir-service-example/main/documentation/privacypass), an implementation of the Privacy Pass publicly verifiable tokens.
2323

24-
The documentation lives at [Swift Package Index](https://swiftpackageindex.com/apple/live-caller-id-lookup-example).
24+
The documentation lives at [Swift Package Index](https://swiftpackageindex.com/apple/pir-service-example).
2525

26-
## Developing Live Caller ID Lookup Example
27-
Building Live Caller ID Lookup Example requires:
26+
## Developing PIR Service Example
27+
Building PIR Service Example requires:
2828
* 64-bit processor with little-endian memory representation
2929
* macOS or Linux operating system
3030
* [Swift](https://www.swift.org/) version 6.0 or later
3131
* Optionally, [XCode](https://developer.apple.com/xcode/) version 16.1 or later
3232

33-
Additionally, developing Live Caller ID Lookup Example requires:
33+
Additionally, developing PIR Service Example requires:
3434
* [Nick Lockwood SwiftFormat](https://github.com/nicklockwood/SwiftFormat)
3535
* [pre-commit](https://pre-commit.com)
3636
* [SwiftLint](https://github.com/realm/SwiftLint)
3737

3838
### Building
39-
You can build Live Caller ID Lookup Example either via Xcode or via command line in a terminal.
39+
You can build PIR Service Example either via Xcode or via command line in a terminal.
4040
#### Xcode
41-
To build Live Caller ID Lookup Example from Xcode, simply open the root directory (i.e., the `live-caller-id-lookup-example` directory) of the repository in Xcode.
41+
To build PIR Service Example from Xcode, simply open the root directory (i.e., the `pir-service-example` directory) of the repository in Xcode.
4242
See the [Xcode documentation](https://developer.apple.com/documentation/xcode) for more details on developing with Xcode.
4343

4444
#### Command line
45-
To build Live Caller ID Lookup Example from command line, open the root directory (i.e., the `live-caller-id-lookup-example` directory) of the repository in a terminal, and run
45+
To build PIR Service Example from command line, open the root directory (i.e., the `pir-service-example` directory) of the repository in a terminal, and run
4646
```sh
4747
swift build -c release
4848
```
@@ -69,10 +69,10 @@ swift test --parallel
6969
> Runtimes may be slow in debug mode.
7070
7171
### Contributing
72-
If you would like to make a pull request to Live Caller ID Lookup Example, please run `pre-commit install`. Then each commit will run some basic formatting checks.
72+
If you would like to make a pull request to PIR Service Example, please run `pre-commit install`. Then each commit will run some basic formatting checks.
7373

7474
### Documentation
75-
Live Caller ID Lookup Example uses DocC for documentation.
75+
PIR Service Example uses DocC for documentation.
7676
For more information, refer to [the DocC documentation](https://www.swift.org/documentation/docc) and the [Swift-DocC Plugin](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin).
7777
#### Xcode
7878
The documentation can be built from Xcode via `Product -> Build Documentation`.

Sources/PIRService/PIRService.docc/DataFormat.md renamed to Sources/PIRService/PIRService.docc/LiveCallerIDLookupDataFormat.md

File renamed without changes.

Sources/PIRService/PIRService.docc/TestingInstructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ swift package experimental-install -c release --product PIRService
5454

5555
### Preparing the dataset
5656

57-
> Seealso: <doc:DataFormat>
57+
> Seealso: <doc:LiveCallerIDLookupDataFormat>
5858
5959
Lets start by making a new directory:
6060
```sh

0 commit comments

Comments
 (0)