Skip to content

Commit 502c1b2

Browse files
committed
Update gist-desktop-apps.html
1 parent f81ddaf commit 502c1b2

File tree

1 file changed

+27
-38
lines changed

1 file changed

+27
-38
lines changed

src/wwwroot/sharp-apps/gist-desktop-apps.html

Lines changed: 27 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -219,72 +219,61 @@
219219

220220
$ app publish -token {GITHUB_TOKEN}
221221

222-
But **our recommendation** is instead to set it in the `GITHUB_GIST_TOKEN` Environment Variable to avoid needing to provide it each time.
222+
**Our recommendation** is instead to set it in the `GITHUB_TOKEN` Environment Variable to avoid needing to provide it each time.
223223

224224
Before publishing our App, our **app.settings** looks something like:
225225

226226
debug true
227227
name Spirals
228228
CefConfig { width:1100, height:900 }
229229

230-
Then in your App's home directory (containing the **app.settings**), run:
231-
232-
$ app publish
233-
234-
This creates a new Gist with your App and is confirmed by a successful response:
235-
236-
App published to: https://api.github.com/gists/4e06df1f1b9099526a7c97721aa7f69c
237-
238-
Publish App to the public registry by re-publishing with app.settings:
230+
To make your App listed in our Global App Directory, include the following metadata about your App:
239231

240232
appName <app alias> # required: alpha-numeric snake-case characters only, 30 chars max
241-
description <app summary> # optional: 20-150 chars
233+
description <app summary> # required: 20-150 chars
242234
tags <app tags> # optional: space delimited, alpha-numeric snake-case, 3 tags max
243235

244-
It also modifies your `app.settings` to include the gist that your App was published to:
245-
246-
debug true
247-
name Spirals
248-
CefConfig { width:1100, height:900 }
249-
publish https://gist.github.com/gistlyn/4e06df1f1b9099526a7c97721aa7f69c
236+
The `appName` is the globally unique short alias you want your App to be launched as, e.g:
250237

251-
Containing the location your App will be published to in the future.
238+
app://my-alias
239+
$ app open my-alias
252240

253-
At this point anyone will now be able to run your App locally with the link it's published to:
241+
If your app.settings contains the app metadata above, publishing the app will publish your App to a Gist & register your App's alias to the Global App Directory:
254242

255-
$ app open https://gist.github.com/gistlyn/4e06df1f1b9099526a7c97721aa7f69c
243+
$ app publish
256244

257-
Or using just the **gist id**:
245+
published to: https://gist.github.com/gistlyn/4e06df1f1b9099526a7c97721aa7f69c
258246

259-
$ app open 4e06df1f1b9099526a7c97721aa7f69c
247+
Run published App:
260248

261-
Or you can give it a friendlier name and make it more discoverable by publishing it to the global App Directory
262-
by updating your app.settings to include **appName**, **description** and **tags** settings, e.g:
249+
x open spirals
263250

264-
debug true
265-
name Spirals
266-
CefConfig { width:1100, height:900 }
267-
publish https://gist.github.com/gistlyn/4e06df1f1b9099526a7c97721aa7f69c
268-
appName spirals
269-
description Explore and generate different Spirals with SVG
270-
tags svg
251+
When your App is published the first time, the created gist URL will be saved in a local `.publish` text file & used for subsequent App publishes.
271252

272-
Now when you re-publish your App:
253+
After it's published anyone will now be able to run your App locally with the global alias (if specified):
273254

274-
$ app publish
255+
app://spirals
256+
$ app open spirals
275257

276-
It will update your Apps gist, register **spirals** with the App directory and output the command everyone will be able to run your App with:
258+
The Gist Id:
277259

278-
App updated at: https://gist.github.com/gistlyn/4e06df1f1b9099526a7c97721aa7f69c
260+
app://4e06df1f1b9099526a7c97721aa7f69c
261+
$ app open 4e06df1f1b9099526a7c97721aa7f69c
279262

280-
Run published App:
263+
Or Gist URL:
281264

282-
app open spirals
265+
$ app open https://gist.github.com/gistlyn/4e06df1f1b9099526a7c97721aa7f69c
283266

284-
Users that are not on Windows can use the `web` tool instead to launch your App in their preferred browser:
267+
Users that are not on Windows can use the `x` dotnet tool instead to launch your App in their preferred browser:
285268

286269
$ x open spirals
287270

271+
If preferred, Windows users can also launch your Gist Desktop App in their preferred browser (i.e. instead of a Chromium Desktop Shell) with the `xapp://` URL Scheme:
272+
273+
xapp://spirals
274+
275+
#### Share your Windows Desktop App creations in minutes!
276+
288277
With its built-in publishing support, you can **create an App from scratch, publish it to a gist, register it in the App directory** -
289278
where your creations are ready for the world to use **in minutes!**
290279

0 commit comments

Comments
 (0)