Skip to content

Commit 2968dca

Browse files
committed
docs: add app logo
1 parent fa3c72c commit 2968dca

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

docs/swa-emu-icon.png

42.3 KB
Loading

readme.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
## SWA EMU: Azure Static Web Apps Emulator (Alpha Preview)
1+
<p align="center">
2+
<h2 align="center">Azure Static Web Apps Emulator</h2>
3+
</p>
4+
<p align="center">
5+
<img align="center" src="docs/swa-emu-icon.png" width="200">
6+
</p>
27

3-
SWA EMU serves as a local emulator for [Azure Static Web Apps](https://bit.ly/2ZNcakP). It can:
8+
Introducing SWA EMU, the Azure Static Web Apps Emulator that serves as a local emulator for [Azure Static Web Apps](https://bit.ly/2ZNcakP). It can:
49

510
- Auto-build your local APP and API
611
- Emulate Authentication
@@ -31,7 +36,7 @@ The Authentication flow is illustrated in the following sequence diagram (or [op
3136

3237
## Disclaimer
3338

34-
SWA EMU is still in alpha preview and not yet ready for prime time. You will encounter issues, so please report them or help us fix them. Your contributions will be very appreciated 🙏
39+
SWA EMU is still in developer preview and not yet ready for prime time. You will encounter issues, so please report them or help us fix them. Your contributions will be very appreciated 🙏
3540

3641
## Quick start
3742

@@ -72,19 +77,19 @@ If you need to override the default values, provide the following options:
7277

7378
## Auth emulation status
7479

75-
| Provider | Local Emulation | Linked OAuth App |
76-
| -------- | --------------- | ---------------- |
77-
| GitHub |||
78-
| Twitter | TODO | |
79-
| Google | TODO | |
80-
| Facebook | TODO | |
81-
| AAD | TODO | |
80+
| Provider | Local Emulation |
81+
| -------- | --------------- |
82+
| GitHub ||
83+
| Twitter | |
84+
| Google | |
85+
| Facebook | |
86+
| AAD | |
8287

8388
## Caveats
8489

85-
- Custom routes are not supported.
86-
- Authorization and roles are not supported.
87-
- The emulator is serving all traffic over HTTP (HTTPS support will be added soon).
90+
- Custom routes are not yet supported.
91+
- Authorization and roles are not supported (see [#7](https://github.com/manekinekko/swa-emulator/issues/7)).
92+
- The emulator is serving all traffic over HTTP (HTTPS support will be added soon) (see [#4](https://github.com/manekinekko/swa-emulator/issues/4)).
8893
- When using GitHub, the OAuth client ID and client secret are provided as-is for dev purposes ONLY. You should create your own OAuth GitHub app!
8994

9095
## Troubleshooting

0 commit comments

Comments
 (0)