Merge pull request #14 from Phoenix-Commerce/feat/test-workflows

feat: testing workflow, adding to the README

.github/workflows/ci.yml

@@ -3,10 +3,10 @@ name: CI Pipeline
 on:
   push:
     branches:
-      - main
+      - develop
   pull_request:
     branches:
-      - main
+      - develop
 
 jobs:
   lint:

README.md

@@ -1,4 +1,21 @@
-# phoenix-framework
+# Phoenix Framework
+An easy-to-use, extensible framework built for ecommerce applications and others
+that require flexibility and ease-of-use. Written for bun for maximum performance
+
+## Vision
+An ultra-fast, easy-to-use framework that has "ready for the big time" features
+
+## Primary components
+* Typescript
+* Apollo Server
+* TypeGoose/Mongoose
+
+## Features included right now
+* Plugin architecture that allows you to create and extend models and resolvers via plugins
+* Role-Based auth
+
+## Features under construction
+Check the GH issues for things I plan to add in the near future
 
 To install dependencies:
 
@@ -18,3 +35,9 @@ To run with auto restart:
 bun run dev
 ```
 
+To run unit and integration tests: (not many beyond a poc for now)
+
+```bash
+bun test
+```
+