docs: change set up guide to use template

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+iann838dev@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING

@@ -0,0 +1,23 @@
+# Contributing Guidelines
+
+## Welcome
+Thank you for considering contributing to Workery! We appreciate your time and effort. Please follow these guidelines to make the process smooth and effective.
+
+Workery is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Workery.
+
+## Reporting Issues
+- Use the [issue tracker](#) to report bugs or suggest features.
+- Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots.
+
+## Pull Requests
+- Provide details of all changes and reasons if applicable.
+- Code must be typed and avoid implicit `any`s where possible.
+- Code must be tested and have reasonable test coverage.
+- Code must match prettier formatted (handled by husky).
+- Commit messages must follow commitlint pattern (handled by husky).
+
+## Review Process
+- All contributions will be reviewed by project maintainers.
+- Maintain open communication during the review process to address any feedback or requests for changes.
+
+We look forward to your contributions!

README.md

@@ -13,13 +13,17 @@ Workery is a Modern, OpenAPI based, fast to code, fully typed, ready for product
 -   🪝 **Dependencies over complicated middleware.** Prepare variables, enforce authentication, and run other tasks before processing a request.
 -   🔩 **Highly flexible and adaptable.** Designed for effortless addition, removal, and replacement of modules or components.
 
-## Installation
+## Create App
 
-```
-yarn add workery
+Create a new Workery app using NPM, Yarn, or PNPM.
+
+```sh
+npm create cloudflare@latest -- --template iann838/workery/templates/hello-world
 ```
 
-## Quick Start
+## Example App
+
+Check out an example of a Workery app after following the [quick start guide](https://workery.iann838.com/guides/first-steps).
 
 ```ts
 import { App } from "workery"
@@ -28,19 +32,21 @@ import z from "zod"
 
 const app = new App<Env>({})
 
-app.get("/entry/{id}", {
+app.get("/items/{itemId}", {
     parameters: {
-        id: Path(z.string().min(2).max(10)),
-        page: Query(z.number().int().min(0).max(20)),
+        itemId: Path(z.number().int().min(0)),
+        q: Query(z.string().optional()),
     },
-    handle({ id, page }) {
-        return { id, page }
+    handle: ({ itemId, q }) => {
+        return { itemId, q }
     },
 })
 
 export default app
 ```
 
-## Star me!
+![Swagger Docs](https://workery.iann838.com/swaggerdocs.jpg)
+
+---
 
-Star this repo if you find it helpful!
+Join other developers in **starring ⭐** this repository to show your support!

docs/guides/basic-params.md

@@ -4,6 +4,7 @@ You can declare "parameters" or "variables" under the `parameters` key on route
 
 ```ts {5,7}
 import { Path } from "workery/parameters"
+import z from "zod"
 
 app.get("/items/{itemId}", {
     parameters: {

docs/guides/first-steps.md

@@ -3,75 +3,62 @@
     <b>Workery</b>
 </div>
 
-## Installation
+## Create App
 
-Install `workery` using Yarn, NPM, or PNPM.
+Create a new Workery app using NPM, Yarn, or PNPM.
 
 ::: code-group
+```sh [npm]
+npm create cloudflare@latest -- --template iann838/workery/templates/hello-world
+```
 ```sh [yarn]
-yarn add workery
+yarn create cloudflare@latest --template iann838/workery/templates/hello-world
 ```
-```sh [npm]
-npm install workery
+```sh [yarn-v1]
+yarn create cloudflare --template iann838/workery/templates/hello-world
 ```
 ```sh [pnpm]
-pnpm add workery
+pnpm create cloudflare@latest --template iann838/workery/templates/hello-world
 ```
 :::
 
-::: info About imports
-You may need `"moduleResolution": "Bundler"` enabled on your `tsconfig.json` for imports to work properly.
-:::
-
-## Create app
-
-The simplest Workery `index.ts` could look like this:
-
-```ts
-import { App } from "workery"
-
-const app = new App<Env>({})
-
-app.get("/", {
-    parameters: {},
-    handle: () => {
-        return { message: "Hello World" }
-    },
-})
-```
+Now, you app is set up, `cd` into the new folder.
 
-## Run locally
+## Run Server
 
-Run your app locally:
+Run local development server:
 
 ::: code-group
-```sh [yarn]
-yarn dev
-```
 ```sh [npm]
 npm run dev
 ```
+```sh [yarn]
+yarn dev
+```
 ```sh [pnpm]
-pnpm run dev
+pnpm dev
 ```
 :::
 
 
-## Check output
+## Check Output
 
 Open your browser at http://127.0.0.1:8787.
 
 You will see the JSON response as:
 
 ```json
-{ "message": "Hello World" }
+{"message":"Hello World"}
 ```
 
-## Add routes
+## Add Routes
 
 Let's add a new route:
 
 ```ts
+import { Path, Query } from "workery/parameters"
+import z from "zod"
+
 app.get("/items/{itemId}", {
     parameters: {
         itemId: Path(z.number().int().min(0)),
@@ -83,23 +70,40 @@ app.get("/items/{itemId}", {
 })
 ```
 
-## Interactive API docs
+## Interactive Docs
 
 Now go to http://127.0.0.1:8787/docs.
 
 You will see the interactive API documentation (provided by [Swagger UI](https://github.com/swagger-api/swagger-ui)), **try it out**:
 
 ![Swagger UI Docs](/swaggerdocs.jpg)
 
-## Alternative API docs
+## Alternative Docs
 
 And now, go to http://127.0.0.1:8787/redoc.
 
-You will see the alternative documentation (provided by [ReDoc](https://github.com/Rebilly/ReDoc)):
+You will see the static API documentation (provided by [ReDoc](https://github.com/Rebilly/ReDoc)):
 
 ![ReDoc Docs](/redocdocs.jpg)
 
-## OpenAPI Specification
+## Deploy App
+
+Deploy your app to Cloudflare Workers:
+
+::: code-group
+```sh [npm]
+npm run deploy
+```
+```sh [yarn]
+yarn deploy
+```
+```sh [pnpm]
+pnpm deploy
+```
+:::
+
+
+## OpenAPI Spec
 
 Workery generates a "schema" with all your API using the **OpenAPI** standard for defining APIs.