Added readme

el-davo · Mar 10, 2017 · 06382dc · 06382dc
1 parent 92cc4a9
commit 06382dc
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,55 @@
+# Platmatic
+
+A desktop application written in electron and react for interacting with cloud foundry
+
+## Features
+
+* Search functionality (Search for apps or third party services)
+* SSH into containers with one click
+* Lists system wide events (I.e. app crashes)
+* Tail app logs with one click
+* Auto login and token refresh
+* Works on MAC/Windows/Linux
+* Live graphs of memory and CPU usage
+* Able to create apps on cloud foundry through this tool
+* Market
+
+## Development
+
+### Install
+
+``
+npm install
+``
+
+### Run in dev mode
+
+```
+npm run dev
+```
+
+### Tests
+
+```
+npm run test-watch
+```
+
+```
+npm run lint
+```
+
+### Builing
+
+#### Windows
+
+```
+npm run package:win
+```
+
+#### MAC
+
+This requires building on a mac
+
+```
+npm run package:mac
+```
diff --git a/app/app.html b/app/app.html
@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8">
-  <title>Cloud Foundry</title>
+  <title>platmatic</title>
   <link rel="stylesheet" href="../node_modules/font-awesome/css/font-awesome.min.css"/>
   <link rel="stylesheet" href="../node_modules/react-redux-toastr/lib/css/react-redux-toastr.min.css"/>
   <link rel="stylesheet" href="../node_modules/fixed-data-table-2/dist/fixed-data-table.css"/>