[🪢] Merge pull request #2 from Flow-Works/vite

Flow-Works · Oct 16, 2023 · 930f40d · 930f40d
2 parents 9bef524 + ccc2332
commit 930f40d
Show file tree

Hide file tree

Showing 6 changed files with 130 additions and 2,260 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,46 @@
 <div align="center">
+  <img src="https://raw.githubusercontent.com/Flow-Works/FlowOS/main/public/assets/logo.svg" width="100px">
+  <p style="font-size: 28px; font-weight: bold">Flow OS</p>
+  <img src="https://img.shields.io/github/stars/flow-works/flowos-2.0?style=for-the-badge" />
 
-  # FlowOS Next
-  The *future* of FlowOS.
+  <img src="https://img.shields.io/github/issues-pr/flow-works/flowos-2.0?style=for-the-badge" />
 
-  [![TypeScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/ts-standard)
+  <img src="https://img.shields.io/github/forks/flow-works/flowos-2.0?style=for-the-badge&color=orange" />
 
-  ![GitHub](https://img.shields.io/github/license/Flow-Works/FlowOS-2.0?style=flat)
-  [![build](https://github.com/Flow-Works/FlowOS-2.0/actions/workflows/build.yml/badge.svg)](https://github.com/Flow-Works/FlowOS-2.0/actions/workflows/build.yml)
-  ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/t/Flow-Works/FlowOS-2.0)
+  <img src="https://img.shields.io/github/commit-activity/t/Flow-Works/FlowOS-2.0?style=for-the-badge&color=violet" />
+  <br><br>
+  <i>The next generation of Flow OS</i>
+  <br>
+<a href="https://docs.flow-works.me"><strong>Read the docs »</strong></a>
+  <hr>
+
+</div>
 
+## What is Flow OS?
+Flow OS is a web OS proxy made for the Titanium Network 2023 Proxathon. It's extremly customizable with an API to make your own apps, themes, and modules.
 
-</div>
+## Getting Started
+To run Flow OS on your local machine, you need Node.js 16 or above. 
+* Clone the repository
+```
+git clone https://github.com/flow-works/flowos
+```
+* Install packages
+```
+npm install
+```
+* Build and run!
+```
+npm run build
+npm run serve
+```
+
+## Made with
+Flow OS is made with the following software:
+* [Filer](https://github.com/filerjs/filer)
+* [PrismJS](https://github.com/PrismJS/prism)
+* [Vite](https://vitejs.dev)
+* [Ultraviolet](https://github.com/titaniumnetwork-dev/ultraviolet)
+
+## License
+Flow OS is licensed under the MIT license. See the `LICENSE` file for more information.
diff --git a/public/index.html → index.html b/public/index.html → index.html
@@ -3,9 +3,10 @@
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Document</title>
+  <title>Flow OS</title>
 </head>
 <body>
   <script src="https://unpkg.com/filer"></script>
+  <script src="./src/index.ts" type="module"></script>
 </body>
 </html>