From f43a3548fe27b27e7013d4a92989eac7b483ce29 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?G=C3=B6khan=20=C3=96zt=C3=BCrk?= <gokhaanozturk@gmail.com>
Date: Mon, 14 Aug 2023 13:27:03 +0300
Subject: [PATCH] docs: revise getting-started

---
 src/stories/GettingStarted.mdx | 106 ++++++++++++++++++++++++++++++---
 1 file changed, 99 insertions(+), 7 deletions(-)

diff --git a/src/stories/GettingStarted.mdx b/src/stories/GettingStarted.mdx
index 438684b..09f7c25 100644
--- a/src/stories/GettingStarted.mdx
+++ b/src/stories/GettingStarted.mdx
@@ -12,18 +12,110 @@ import { Meta } from '@storybook/addon-docs';
 
 # Getting Started
 
-TBD
+![Logo](./resources/rocket-ui-logo-light.svg#gh-light-mode-only)
 
-## Features
+## Installation
 
-TBD
+```sh
+yarn add @rocketui/vue
+```
 
-## Installation
+## Usage
+
+Your `main.{js,ts}` file should look like this:
+
+```js
+import { createApp } from 'vue';
+import App from './App.vue';
+
+// Import the Styles
+import '@rocketui/vue/dist/style.css';
+
+createApp(App).mount('#app');
+```
+
+Then you can use the components in your `App.vue` file:
+
+```js
+<script setup>
+import { RButton } from '@rocketui/vue';
+</script>
+
+<template>
+  <RButton>Rocket UI Button</RButton>
+</template>
+```
+
+## Development
+
+### Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Type Support for `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+
+If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+
+1. Disable the built-in TypeScript Extension
+   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
 
-TBD
+### Customize configuration
 
-## Roadmap
+See [Vite Configuration Reference](https://vitejs.dev/config/).
 
-TBD
+### Project Setup
+
+```sh
+yarn install
+```
+
+#### Compile and Hot-Reload for Development
+
+```sh
+yarn dev
+```
+
+#### Type-Check, Compile and Minify for Production
+
+```sh
+yarn build
+```
+
+#### Run Unit Tests with [Vitest](https://vitest.dev/)
+
+```sh
+yarn test:unit
+```
+
+#### Lint with [ESLint](https://eslint.org/)
+
+```sh
+yarn lint
+```
+
+## Contribution
+
+We welcome contributions of any kind including documentation, bug reports, bug fixes, feature requests, feature implementations, and pull requests. If you're interested in contributing to this project, please follow these guidelines:
+
+- Fork this repository to your own GitHub account and then clone it to your local device.
+- Install the dependencies by running `yarn install`.
+- Run `yarn dev` to start the dev server and see your changes in real-time as you edit the source files.
+- Create a new branch for your changes, e.g. `git checkout -b my-feature`.
+- Make your changes and commit them with a descriptive message.
+- Push your changes to your forked repository, e.g. `git push -u origin my-feature`.
+- Create a pull request from your forked repository to this repository, and describe the changes you've made and why they should be merged.
+- Before submitting a pull request, please make sure that your changes pass the following checks:
+
+The unit tests pass by running `yarn test:unit`.
+The code passes the ESLint check by running `yarn lint`.
+The code builds without errors by running `yarn build`.
+
+We aim to respond to all pull requests and issues within 48 hours. Thank you for your interest in contributing to Rocket UI Vue!
 
 ## License
+
+MIT. See [LICENSE](https://github.com/Teknasyon/rocket-ui/blob/master/LICENSE) for more details.