Add framework readmes

Jake Lazaroff · Jake Lazaroff · commit b1d61917c750 · 2024-11-25T15:37:24.000-05:00
diff --git a/js-pkg/create-y-sweet-app/README.md b/js-pkg/create-y-sweet-app/README.md
@@ -10,4 +10,4 @@ npx create-y-sweet-app@latest
 
 You'll be asked for the name of your project and then prompted to choose a framework.
 
-While Y-Sweet works with any web framework, `create-y-sweet-app` includes quick-start templates for [Next.js](https://nextjs.org) and [Remix](https://remix.run).
+While Y-Sweet works with any web stack, `create-y-sweet-app` includes quick-start templates for [Next.js](https://nextjs.org) and [Remix](https://remix.run).
diff --git a/js-pkg/create-y-sweet-app/src/frameworks/nextjs/README.md b/js-pkg/create-y-sweet-app/src/frameworks/nextjs/README.md
@@ -0,0 +1,21 @@
+This is a [Y-Sweet](https://jamsocket.com/y-sweet) project using [Next.js](https://nextjs.org). It was bootstrapped with [`create-y-sweet-app`](https://www.npmjs.com/package/create-y-sweet-app).
+
+## Getting Started
+
+First, run the development server:
+
+```sh
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) in your browser to see the app running. If you open it in multiple windows, you'll see that all the state in the app is automatically kept in sync!
+
+You can start editing the page by modifying `app/page.tsx`.
+
+## Learn More
+
+While you're building your Y-Sweet app, you might also want to check out:
+
+- [Y-Sweet documentation](https://docs.jamsocket.com/y-sweet/) - learn about Y-Sweet's features and API.
+- [Discord server](https://discord.gg/N5sEpsuhh9) - chat with the developers and get help from other users.
+- [Y-Sweet GitHub repository](https://github.com/jamsocket/y-sweet) - leave feedback, report bugs and contribute to Y-Sweet.
diff --git a/js-pkg/create-y-sweet-app/src/frameworks/nextjs/app/page.tsx b/js-pkg/create-y-sweet-app/src/frameworks/nextjs/app/page.tsx
@@ -1,7 +1,7 @@
 import { DocumentManager } from "@y-sweet/sdk";
 import { YDocProvider } from "@y-sweet/react";
 
-import { MyCollaborativeApp } from "@/components/MyCollaborativeApp";
+import { App } from "@/components/App";
 
 const manager = new DocumentManager(process.env.CONNECTION_STRING!);
 
@@ -17,7 +17,7 @@ export default async function Home() {
 
   return (
     <YDocProvider docId={docId} authEndpoint={getClientToken}>
-      <MyCollaborativeApp />
+      <App />
     </YDocProvider>
   );
 }
diff --git a/js-pkg/create-y-sweet-app/src/frameworks/nextjs/components/App.tsx b/js-pkg/create-y-sweet-app/src/frameworks/nextjs/components/App.tsx
@@ -3,7 +3,7 @@ import { Presence } from "./Presence";
 import { Footer } from "./Footer";
 import { Todos } from "./Todos";
 
-export function MyCollaborativeApp() {
+export function App() {
   return (
     <div className="min-h-screen flex flex-col justify-between max-w-[60rem] mx-auto before:content-[''] before:block before:absolute before:top-0 before:left-0 before:right-0 before:border-t-4 before:border-[#fc5c86]">
       <header className="flex flex-col gap-8 p-12">
diff --git a/js-pkg/create-y-sweet-app/src/frameworks/remix/README.md b/js-pkg/create-y-sweet-app/src/frameworks/remix/README.md
@@ -0,0 +1,21 @@
+This is a [Y-Sweet](https://jamsocket.com/y-sweet) project using [Remix](https://remix.run). It was bootstrapped with [`create-y-sweet-app`](https://www.npmjs.com/package/create-y-sweet-app).
+
+## Getting Started
+
+First, run the development server:
+
+```sh
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) in your browser to see the app running. If you open it in multiple windows, you'll see that all the state in the app is automatically kept in sync!
+
+You can start editing the page by modifying `app/page.tsx`.
+
+## Learn More
+
+While you're building your Y-Sweet app, you might also want to check out:
+
+- [Y-Sweet documentation](https://docs.jamsocket.com/y-sweet/) - learn about Y-Sweet's features and API.
+- [Discord server](https://discord.gg/N5sEpsuhh9) - chat with the developers and get help from other users.
+- [Y-Sweet GitHub repository](https://github.com/jamsocket/y-sweet) - leave feedback, report bugs and contribute to Y-Sweet.
diff --git a/js-pkg/create-y-sweet-app/src/frameworks/remix/app/components/App.tsx b/js-pkg/create-y-sweet-app/src/frameworks/remix/app/components/App.tsx
@@ -3,7 +3,7 @@ import { Presence } from "./Presence";
 import { Footer } from "./Footer";
 import { Todos } from "./Todos";
 
-export function MyCollaborativeApp() {
+export function App() {
   return (
     <div className="min-h-screen flex flex-col justify-between max-w-[60rem] mx-auto before:content-[''] before:block before:absolute before:top-0 before:left-0 before:right-0 before:border-t-4 before:border-[#fc5c86]">
       <header className="flex flex-col gap-8 p-12">
diff --git a/js-pkg/create-y-sweet-app/src/frameworks/remix/app/routes/_index.tsx b/js-pkg/create-y-sweet-app/src/frameworks/remix/app/routes/_index.tsx
@@ -1,7 +1,7 @@
 import { type MetaFunction } from "@remix-run/react";
 import { YDocProvider } from "@y-sweet/react";
 
-import { MyCollaborativeApp } from "~/components/MyCollaborativeApp";
+import { App } from "~/components/App";
 
 export const meta: MetaFunction = () => [{ title: "Y-Sweet + Remix" }];
 
@@ -18,7 +18,7 @@ export default function Home() {
 
   return (
     <YDocProvider docId={docId} authEndpoint="/auth">
-      <MyCollaborativeApp />
+      <App />
     </YDocProvider>
   );
 }

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,4 @@ npx create-y-sweet-app@latest`
`10`	`10`
`11`	`11`	`You'll be asked for the name of your project and then prompted to choose a framework.`
`12`	`12`
`13`		-While Y-Sweet works with any web framework, `create-y-sweet-app` includes quick-start templates for [Next.js](https://nextjs.org) and [Remix](https://remix.run).
	`13`	+While Y-Sweet works with any web stack, `create-y-sweet-app` includes quick-start templates for [Next.js](https://nextjs.org) and [Remix](https://remix.run).