diff --git a/README.md b/README.md index 15fea12..2f25ba1 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -# iosSecureFieldv1 \ No newline at end of file +# iOSSecureFieldv1 + +This project demonstrates the use of SwiftUI's SecureField component for handling sensitive information input, such as passwords, in a simple mock application. + +## Description + +The application includes three screens: + +- **Username/Password:** Allows users to input a username and password, then displays the submitted information securely. +- **Email/Pin:** Similar to Username/Password but designed for a different use case (e.g., email and PIN). +- **Phone Number:** Enables users to input a phone number, displaying the submitted data securely. + +This project aims to showcase the SecureField component's functionality in SwiftUI for handling sensitive information securely. + +## Usage + +To use this project, follow these steps: + +1. Clone the repository: + + ```bash + git clone https://github.com/appknox/iosSecureFieldv1.git +2. Open the project in Xcode. +3. Navigate through the screens to observe SecureField usage and the handling of sensitive information. + +## Compatibility +- **SwiftUI Version**: Compatible with SwiftUI on iOS 13 and later. + +## Contributions +This project is a mock showcase and is not open for public contribution. + +## License +This project is licensed under the [MIT License](LICENSE).