[solidjs-pod] 3. Update the readme

[Zelig880]

Background

The kit should include a thorough README with all architectural decisions the user should be aware of when utilizing it. It shouldn't rewrite docs for existing libraries but any key decisions should be documented. This is what will be visible to users on the website when they look at the details page.

Acceptance

• [ ] Update the below template with relevant information for users who want to utilize this kit with appropriate instructions.

Template

starter kit

This starter kit features .

Table of Contents

• Overview
  • Tech Stack
  • Included Tooling
  • Example Components
• Installation
  • CLI
  • Manual
• Commands
• Demo Implementation

Overview

Tech Stack

• List of technologies used with links to relevant doc pages

Included Tooling

• List of tooling used, e.g. jest, Storybook, ESLint, Prettier, etc., with their relevant doc pages linked
• Jest - Test runner
• TypeScript - Type checking
• Storybook - Component library
• ESLint - Code linting
• Prettier - Code formatting

Architectural Decisions

List all important architectural decisions here and patterns users should be aware of.

Example Components

In this starters/<kit path>/src directory you will find the directories.

## Installation ### CLI (Recommended) ```bash npx create-starter-dev ``` - Follow the prompts to select the starter kit and name your new project. - `cd` into your project directory and run `npm install`. - Run `npm run dev` to start the development server. - Open your browser to `http://localhost:3000` to see the included example code running. ### Manual ```bash git clone https://github.com/thisdot/starter.dev.git ``` - Copy and rename the `starters/` directory to the name of your new project. - `cd` into your project directory and run `npm install`. - Run `npm run dev` to start the development server. - Open your browser to `http://localhost:3000` to see the included example code running. ## Commands - List of helpful package.json scripts and their purpose ## Demo Implementation [Repository](https://github.com/thisdot/starter.dev-showcases/tree/main/) The demo application re-implements some of GitHub's pages and functionality. It uses the OAuth credentials in GitHub to authenticate users with their GitHub accounts and uses RxJS to fetch data from the GitHub API. Check out the link above to learn more or check out the demo!

[mbicknese]

Done in #445