Skip to content

Commit 88d54e8

Browse files
authored
docs: remove NFC tag operations (moved to v1-with-nfc branch) (#72)
NFC code was removed from main and preserved in the v1-with-nfc branch. Drop the now-stale NFC content from the docs: - README: replace the NFC Tag Operations section with a pointer to the v1-with-nfc branch, drop background tag reading from the intro tagline, and remove the NFC blog link - CLAUDE.md: remove the NFC architecture notes and the /NFC/ tree entry (the Scan tab and QR were removed in the same change, so those stale mentions are corrected too)
1 parent 890b7b0 commit 88d54e8

2 files changed

Lines changed: 3 additions & 71 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,6 @@ The app uses iOS 17's `@Observable` macro for state management with clean separa
7777

7878
### Key Features Implementation
7979

80-
**NFC Support**:
81-
- Tag reading/writing capabilities (`/NFC/`)
82-
- Background tag reading support
83-
- Application-specific tag data format
84-
8580
**Offline Support**:
8681
- Network monitoring (`/Networking/NetworkMonitor.swift`)
8782
- Keychain storage for secure data persistence
@@ -102,8 +97,7 @@ NativeAppTemplate/
10297
├── UI/ # SwiftUI views by feature
10398
├── Sessions/ # Authentication
10499
├── Persistence/ # Keychain storage
105-
├── Utilities/ # Helpers and extensions
106-
└── NFC/ # NFC functionality
100+
└── Utilities/ # Helpers and extensions
107101
```
108102

109103
### Error Handling (CodedError System)

README.md

Lines changed: 2 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# NativeAppTemplate-Free-iOS
22

3-
NativeAppTemplate-Free-iOS is a modern, comprehensive, and production-ready native iOS app with user authentication and [background tag reading](https://developer.apple.com/documentation/corenfc/adding-support-for-background-tag-reading).
3+
NativeAppTemplate-Free-iOS is a modern, comprehensive, and production-ready native iOS app with user authentication and a full CRUD example.
44
This iOS app is a free version of [NativeAppTemplate-iOS (Solo)](https://nativeapptemplate.com/products/ios-solo) and [NativeAppTemplate-iOS (Team)](https://nativeapptemplate.com/products/ios-team).
55

66
The Android version is available here: [NativeAppTemplate-Free-Android](https://github.com/nativeapptemplate/NativeAppTemplate-Free-Android).
@@ -43,68 +43,7 @@ NativeAppTemplate-Free-iOS uses modern iOS development tools and practices, incl
4343

4444
## NFC Tag Operations
4545

46-
<details>
47-
<summary><strong>How NFC tag writing and background reading works</strong></summary>
48-
49-
### Overview
50-
51-
![Screenshot showing Overview before](https://github.com/nativeapptemplate/NativeAppTemplate-Free-iOS/blob/main/docs/images/overview_before.png "Screenshot showing Overview before")
52-
53-
![Screenshot showing Overview after](https://github.com/nativeapptemplate/NativeAppTemplate-Free-iOS/blob/main/docs/images/overview_after.png "Screenshot showing Overview after")
54-
55-
The app replaces traditional paper tags with NFC tags to efficiently manage walk-in customer waitlists. It writes application-specific information onto your NFC cards (referred to as :red_circle: **Server Tag** and :large_blue_circle: **Customer Tag**).
56-
57-
**For Customers:**
58-
When a customer scans a :large_blue_circle: **Customer Tag**, they can view the :green_circle: **Number Tags Webpage** (a public webpage) on their mobile browser. This page displays completed Number Tags.
59-
60-
**For Staff:**
61-
By scanning a :red_circle: **Server Tag** paired with the :large_blue_circle: **Customer Tag**, staff can complete a Number Tag. Completed Number Tags automatically appear on the :green_circle: **Number Tags Webpage** for customer reference.
62-
63-
### How It Works
64-
65-
![Screenshot showing Write Application Info to Tag screen, Scan Tag screen, and Shop Detail screen](https://github.com/nativeapptemplate/NativeAppTemplate-Free-iOS/blob/main/docs/images/screenshots_nfc.png "Screenshot showing Write Application Info to Tag screen, Scan Tag screen, and Shop Detail screen")
66-
67-
1. Write application info to pair **Number Tags** (Server Tag and Customer Tag) or a **Customer QR code**:
68-
- Go to: **Shops > [Shop] > Shop Settings > Manage Number Tags > [Number Tag]**.
69-
2. Scan a **Server Tag** in the **Scan** tab.
70-
3. View the updated **Number Tags** status in the **Shop Detail** screen or on the **Number Tags Webpage** (see Background Tag Reading GIF below).
71-
72-
### Recommended NFC Tags
73-
For best performance, use **NTAG215 (540 bytes)** tags.
74-
Example: [50pcs NFC Cards Ntag215](https://www.amazon.com/dp/B087FRYY8S) (Amazon USA).
75-
76-
---
77-
78-
### Background Tag Reading
79-
80-
![Gif showing Background Tag Reading](https://github.com/nativeapptemplate/NativeAppTemplate-Free-iOS/blob/main/docs/images/nfc.gif "Showing Background Tag Reading")
81-
82-
1. Scan a **Server Tag**.
83-
2. View the updated **Number Tags** status in the **Shop Detail** screen or on the **Number Tags Webpage**.
84-
85-
The **Number Tags Webpage** updates in real-time using Rails [Turbo](https://turbo.hotwired.dev).
86-
This functionality is part of the open-source [nativeapptemplateapi](https://github.com/nativeapptemplate/nativeapptemplateapi) backend.
87-
88-
> **Note:**
89-
> The GIF above shows [MyTurnTag Creator for iOS](https://apps.apple.com/app/myturntag-creator/id1516198303) in action, which may behave slightly differently from **NativeAppTemplate-Free-iOS**.
90-
91-
### Associated Domains Requirement (iOS)
92-
For background tag reading to work correctly on **iOS**, you must configure **Associated Domains** in your app.
93-
94-
To set up Associated Domains on iOS, follow these steps:
95-
1. Add your domain (e.g., `applinks:api.example.com`) to the **Associated Domains** section in Xcode under **Signing & Capabilities**.
96-
2. Configure the **apple-app-site-association (AASA)** file and host it on your server.
97-
3. Verify that the **AASA** file is correctly configured and accessible by checking its contents at the following URL:
98-
99-
🔗 [https://app-site-association.cdn-apple.com/a/v1/api.example.com](https://app-site-association.cdn-apple.com/a/v1/api.example.com)
100-
101-
4. Uninstall **NativeAppTemplate-Free-iOS**, reset your device, and then reinstall **NativeAppTemplate-Free-iOS** to ensure the changes take effect.
102-
103-
For detailed instructions, refer to Apple's official documentations:
104-
- [Adding Support for Background Tag Reading](https://developer.apple.com/documentation/corenfc/adding-support-for-background-tag-reading)
105-
- [Supporting Associated Domains](https://developer.apple.com/documentation/xcode/supporting-associated-domains)
106-
107-
</details>
46+
NFC tag writing and background tag reading were part of v1 and have been removed from the current version. The full NFC implementation remains available in the [`v1-with-nfc`](https://github.com/nativeapptemplate/NativeAppTemplate-Free-iOS/tree/v1-with-nfc) branch.
10847

10948
## Not Included in the Free Version
11049

@@ -175,7 +114,6 @@ Xcode will automatically run SwiftLint if it is installed.
175114
## Blogs
176115

177116
- [Key Differences in MVVM Architecture: iOS vs. Android](https://medium.com/@dadachix/key-differences-in-mvvm-architecture-ios-vs-android-e239d30b2ea7)
178-
- [Cross-Platform Background NFC Tag Reading](https://medium.com/@dadachix/cross-platform-background-nfc-tag-reading-8a704f0cb6e9)
179117

180118
## Contributing
181119

0 commit comments

Comments
 (0)