Skip to content

Commit a37ba69

Browse files
committed
updates
1 parent 942c1e2 commit a37ba69

File tree

2 files changed

+15
-28
lines changed

2 files changed

+15
-28
lines changed

README.md

+11-23
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
# AugmentOS-Cloud-Example-App
22

3+
### Install AugmentOS on your phone
34

4-
![header](https://github.com/user-attachments/assets/f69defec-7011-45f2-b258-94e6c712a758)
5+
AugmentOS install links: [AugmentOS.org/install](https://AugmentOS.org/install)
56

6-
### Download AugmentOS on your phone
7-
8-
[Download links](https://drive.google.com/drive/folders/1l99ffBiWHnAe06HSJcgjIG-SnMuio70_?usp=sharing)
9-
10-
Use the APK that is pointing to the *staging* env, as currently our dev / prod environments do not have the appstore
11-
12-
13-
### Set up ngrok
7+
### (Easiest way to get started) Set up ngrok
148

159
1. `brew install ngrok`
1610

@@ -22,20 +16,15 @@ Use the APK that is pointing to the *staging* env, as currently our dev / prod e
2216

2317
<img width="181" alt="image" src="https://github.com/user-attachments/assets/36192c2b-e1ba-423b-90de-47ff8cd91318" />
2418

25-
1. Navigate to [AugmentOS.dev](https://augmentos.dev/)
19+
1. Navigate to [console.AugmentOS.org](https://console.AugmentOS.org/)
2620

27-
2. Click "Sign In", and log in with the same Google account you're using for AugmentOS
21+
2. Click "Sign In", and log in with the same account you're using for AugmentOS
2822

2923
3. Click "Create App"
3024

31-
4. Set a UNIQUE package name like `org.yourlastname.yoursocialsecuritynumber`
32-
33-
5. For webhook url, enter your ngrok's static url, appended by `webhook`
34-
* EX:
35-
* If you Ngrok URL is: `https://my-static-url.ngrok-free.app`
36-
* Then you enter `https://my-static-url.ngrok-free.app/webhook`
25+
4. Set a unique package name like `com.yourName.yourAppName`
3726

38-
![guide](https://github.com/user-attachments/assets/681df211-ea1a-4fd9-9563-f1f7c81e9565)
27+
5. For "Public URL", enter your Ngrok's static URL
3928

4029
### Get your APP running!
4130

@@ -45,14 +34,13 @@ Use the APK that is pointing to the *staging* env, as currently our dev / prod e
4534

4635
3. cd into your repo, then type `bun install`
4736

48-
4. Edit your `index.ts` to match the app you registered at [AugmentOS.dev](https://augmentos.dev/)
37+
4. Edit your `index.ts` to match the app you registered at [console.AugmentOS.org](https://console.AugmentOS.org/)
4938

5039
```typescript
5140
const app = new ExampleAugmentOSApp({
52-
packageName: 'org.yourlastname.yoursocialsecuritynumber', // make sure this matches your app in dev console
53-
apiKey: 'your_api_key', // Not used right now, can be anything
54-
port: 3000, // The port you're hosting the server on
55-
augmentOSWebsocketUrl: 'wss://staging.augmentos.org/tpa-ws' //IMPORTANT: USE STAGING
41+
packageName: 'com.yourName.yourAppName', // The packageName you specified on console.AugmentOS.org
42+
apiKey: 'your_api_key', // Get this from console.AugmentOS.org
43+
port: 3000 // The port you're hosting the server on
5644
});
5745
```
5846

index.ts

+4-5
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,12 @@ class ExampleAugmentOSApp extends TpaServer {
2828
}
2929

3030
// Start the server
31-
// DEV CONSOLE URL: https://augmentos.dev/
31+
// DEV CONSOLE URL: https://console.AugmentOS.org/
3232
// Get your webhook URL from ngrok (or whatever public URL you have)
3333
const app = new ExampleAugmentOSApp({
34-
packageName: 'org.augmentos.exampleapp', // make sure this matches your app in dev console
35-
apiKey: 'your_api_key', // Not used right now, play nice
36-
port: 3000, // The port you're hosting the server on
37-
augmentOSWebsocketUrl: 'wss://dev.augmentos.org/tpa-ws' //AugmentOS url
34+
packageName: 'org.augmentos.exampleapp', // The packageName you specified on console.AugmentOS.org
35+
apiKey: 'your_api_key', // Get this from console.AugmentOS.org
36+
port: 3000 // The port you're hosting the server on
3837
});
3938

4039
app.start().catch(console.error);

0 commit comments

Comments
 (0)