Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Sample App + Update Instructions #17

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tamerbader
Copy link
Contributor

  • Renamed Example project from MobilePaymentsSwiftUIExample to DonutCounter
  • Added instructions on how to utilize the MPSDK donut counter example app

@@ -1,17 +1,89 @@
# Square Mobile Payments SDK Example App
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may end up having multiple example apps so this README may need to be more generic but for now I think it's fine to have it specific to the donut counter app

Example/README.md Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the updates to this! So much more detailed!

Scripts/templates/README.md.erb Outdated Show resolved Hide resolved
Example/DonutCounter/DonutCounter/MobilePaymentsApp.swift Outdated Show resolved Hide resolved
@tamerbader tamerbader force-pushed the tbader/additional-sample-app-updates branch from 162948c to 3a3fbcb Compare November 26, 2024 17:46
@@ -1,17 +1,89 @@
# Square Mobile Payments SDK Example App
# 🍩 Donut Counter - A Square Mobile Payments SDK Example App
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks awesome!! My only feedback is we should be consistent with calling it a "sample app" as opposed to "example app" to match our existing wording: https://developer.squareup.com/docs/sample-apps

I've got a TODO item for the next train to update this page and add links to this sample!


### Assumptions and prerequisites
Donut Counter is a sample application for building with the [Square Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk) on iOS. The app demonstrates how to install and initialize the SDK in a SwiftUI project as well as utilizing the API's and user interfaces provided by the SDK to authorize a merchant, pair and manage card readers, and take a payment. To get started, follow the steps below.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be "utilizing the APIs" (no apostrophe)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants