Skip to content

Commit e67b1a9

Browse files
authored
Merge pull request #112 from thefrontside/mk/readmes
Tiny enhancements to READMEs
2 parents f90b2c4 + 6b8aa1c commit e67b1a9

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ person.name // => Paul Waters
4141
person.email // => paul.waters@gmail.com
4242
```
4343

44+
If you have an application that uses `auth0`, check out [`@simulacrum/auth0-simulator`](./packages/auth0) on how you can get started.
45+
46+
We also have complete examples for [`nextjs with auth0 react`](./examples/nextjs-with-auth0-react) and [`nextjs with nextjs auth0`](./examples/nextjs-with-nextjs-auth0).
47+
4448
## Development
4549

4650
```

packages/auth0/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ If this does not meet your needs then please create a github issue to start a co
2121

2222
## Quick Start
2323

24+
This quick start assumes you have your own app with auth0. Check out [`nextjs with auth0 react`](./examples/nextjs-with-auth0-react) and [`nextjs with nextjs auth0`](./examples/nextjs-with-nextjs-auth0) for more complete examples that provides a barebone application.
25+
2426
### Graphql
2527

2628
Let's start our server.
@@ -62,7 +64,7 @@ mutation CreateSimulation {
6264
}
6365
```
6466

65-
This mutation creates your first simulation, and runs it in memory. Every time you start the server, you will need to apply these mutations. This can also be done programmatically which will be your likely interface while writing tests.
67+
This mutation creates your first simulation. Every time you start the server, you will need to apply these mutations. This can also be done programmatically which will be your likely interface while writing tests.
6668

6769
![create simulation](./docs/create-simulation.png).
6870

@@ -99,14 +101,12 @@ The following examples are written in Typescript, but using Typescript is not a
99101
```ts
100102
import { main } from "effection";
101103
import { createSimulationServer, Server } from "@simulacrum/server";
102-
import { auth0 } from ".";
104+
import { auth0 } from "@simulacrum/auth0-simulator";
103105
import { createClient } from "@simulacrum/client";
104106

105107
const port = Number(process.env.PORT) ?? 4000; // port for the main simulation service
106108

107-
// effection is a structured concurrency library and
108-
// this will help us handle errors and shutting down
109-
// the server gracefully
109+
// effection is a structured concurrency library and this will help us handle errors and shutting down the server gracefully
110110
main(function* () {
111111
let server: Server = yield createSimulationServer({
112112
seed: 1,

0 commit comments

Comments
 (0)