diff --git a/README.md b/README.md index e69de29..09427be 100644 --- 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 +``` \ No newline at end of file diff --git a/app/app.html b/app/app.html index 020bc3e..c7f60ed 100644 --- a/app/app.html +++ b/app/app.html @@ -2,7 +2,7 @@ - Cloud Foundry + platmatic