readmes (#134)

* readmes

* Logo fix

* Logo

* Remove video

CODE-OF-CONDUCT.md

@@ -0,0 +1,89 @@
+# 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, caste, color, 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
+maintainers@bloop.ai through e-mail, with an appropriate subject line.
+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.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Next.js project][nextjs-coc]
+
+The original text is from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[nextjs-coc]: https://raw.githubusercontent.com/vercel/next.js/canary/CODE_OF_CONDUCT.md
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

README.md

@@ -1,35 +1,54 @@
-# Mission Control
+<p align="center">
+  <a href="https://vibekanban.com">
+    <picture>
+      <source srcset="frontend/public/vibe-kanban-logo-dark.svg" media="(prefers-color-scheme: dark)">
+      <source srcset="frontend/public/vibe-kanban-logo.svg" media="(prefers-color-scheme: light)">
+      <img src="frontend/public/vibe-kanban-logo.svg" alt="Vibe Kanban Logo">
+    </picture>
+  </a>
+</p>
 
-Orchestration and visualisation over multiple coding agents.
+<p align="center">Get 10X more out of Claude Code, Gemini CLI, Codex, Amp and other coding agents...</p>
+<p align="center">
+  <a href="https://www.npmjs.com/package/vibe-kanban"><img alt="npm" src="https://img.shields.io/npm/v/vibe-kanban?style=flat-square" /></a>
+  <a href="https://github.com/bloop/vibe-kanban/actions/workflows/publish.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/bloop/vibe-kanban/publish.yml?style=flat-square&branch=dev" /></a>
+</p>
 
-## Project Structure
+![](frontend/public/vibe-kanban-screenshot-overview.png)
 
-```
-repo/
-├── backend/               # Rust backend (Axum API)
-│   ├── Cargo.toml
-│   └── src/
-│       ├── main.rs
-│       ├── routes/
-│       └── models/
-├── frontend/              # React + TypeScript app
-│   ├── package.json
-│   ├── vite.config.ts
-│   ├── components.json    # shadcn/ui config
-│   ├── tailwind.config.js
-│   └── src/
-│       ├── components/
-│       │   └── ui/        # shadcn/ui components
-│       ├── lib/
-│       └── app/
-├── shared/                # Shared types/schemas
-│   └── types.ts
-├── Cargo.toml             # Workspace configuration
-├── pnpm-workspace.yaml    # pnpm workspace
-└── package.json           # Root scripts
+## Overview
+
+AI coding agents are increasingly writing the world's code and human engineers now spend the majority of their time planning, reviewing, and orchestrating tasks. Vibe Kanban streamlines this process, enabling you to:
+
+- Easily switch between different coding agents
+- Orchestrate the execution of multiple coding agents in parallel or in sequence
+- Quickly review work and start dev servers
+- Track the status of tasks that your coding agents are working on
+- Centralise configuration of coding agent MCP configs
+
+You can watch a video overview [here](https://youtu.be/TFT3KnZOOAk).
+
+## Installation
+
+Make sure you have authenticated with your favourite coding agent. A full list of supported coding agents can be found in the [docs](https://vibekanban.com/). Then in your terminal run:
+
+```bash
+npx vibe-kanban
 ```
 
-## Getting Started
+## Documentation
+
+Please head to the [website](https://vibekanban.com) for the latest documentation and user guides.
+
+## Support
+
+Please open an issue on this repo if you find any bugs or have any feature requests.
+
+## Contributing
+
+We would prefer that ideas and changes are raised with the core team via GitHub issues, where we can discuss implementation details and alignment with the existing roadmap. Please do not open PRs without first discussing your proposal with the team.
+
+## Development
 
 ### Prerequisites
 
@@ -37,44 +56,20 @@ repo/
 - [Node.js](https://nodejs.org/) (>=18)
 - [pnpm](https://pnpm.io/) (>=8)
 
-### Installation
-
-1. Install dependencies
-
 ```bash
-# Install dependencies
-npm install
+pnpm i
 ```
 
-### Development
+### Running the dev server
 
 ```bash
-# Run both frontend and backend in development mode
-npm dev
+pnpm run dev
 ```
 
-## Tech Stack
+This will start the frontend and backend with live reloading. A blank DB will be copied from the `dev_assets_seed` folder.
 
-### Backend
+### Build from source
 
-- **Rust** with **Axum** web framework
-- **Tokio** async runtime
-- **Tower** middleware
-- **Serde** for JSON serialization
-
-### Frontend
-
-- **React 18** with **TypeScript**
-- **Vite** for build tooling
-- **Tailwind CSS** for styling
-- **shadcn/ui** component library
-- **Radix UI** primitives
-
-## Adding shadcn/ui Components
-
-```bash
-cd frontend
-npx shadcn-ui@latest add button
-npx shadcn-ui@latest add card
-# etc.
-```
+1. Run `build-npm-package.sh`
+2. In the `npx-cli` folder run `npm pack`
+3. You can run your build with `npx [GENERATED FILE].tgz`