@connectedyard/heroku-postico - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

oclif.manifest.json

@@ -1,1 +0,1 @@
-{"version":"0.0.6","commands":{"postico:export":{"id":"postico:export","description":"Export postico favorites for all postgres addons for a team","pluginName":"@connectedyard/heroku-postico","pluginType":"core","aliases":[],"flags":{"team":{"name":"team","type":"option","char":"t","description":"team to use","required":true},"verbose":{"name":"verbose","type":"boolean","description":"Enable extra debug output.","allowNo":false}},"args":[]},"postico:open":{"id":"postico:open","description":"Fetch a list of Heroku postgres databases for a team and connect in Postico","pluginName":"@connectedyard/heroku-postico","pluginType":"core","aliases":[],"flags":{"team":{"name":"team","type":"option","char":"t","description":"team to use","required":true},"verbose":{"name":"verbose","type":"boolean","description":"Enable extra debug output.","allowNo":false}},"args":[]}}}
+{"version":"0.0.7","commands":{"postico:export":{"id":"postico:export","description":"Export a folder containing Postico favorite files for all Heroku postgres databases associated with a team.","pluginName":"@connectedyard/heroku-postico","pluginType":"core","aliases":[],"flags":{"team":{"name":"team","type":"option","char":"t","description":"team to use","required":true},"verbose":{"name":"verbose","type":"boolean","description":"Enable extra debug output.","allowNo":false}},"args":[]},"postico:open":{"id":"postico:open","description":"Fetch Heroku postgres databases for a team to choose from a list and connect in Postico.","pluginName":"@connectedyard/heroku-postico","pluginType":"core","aliases":[],"flags":{"team":{"name":"team","type":"option","char":"t","description":"team to use","required":true},"verbose":{"name":"verbose","type":"boolean","description":"Enable extra debug output.","allowNo":false}},"args":[]}}}

package.json

 {
   "name": "@connectedyard/heroku-postico",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "author": "Josh Kennedy @jkennedy1980",
@@ -5,0 +5,0 @@ "bugs": "https://github.com/PhinCo/heroku-postico/issues",

README.md

@@ -9,10 +9,16 @@ heroku-postico
 
-* [Usage](#usage)
+Tools to make it easier to connect to Heroku postgres databases from [Postico](https://eggerapps.at/postico/). You must have 
+Postico installed for this tool to work. If you've never used Postico - it's one of the best Postgres apps for OSX on the market.
+
+* [Installation](#installation)
 * [Commands](#commands)
+* [Developing](#developing)
 
-# Usage
+# Installation
+
 ```sh-session
-$ npm install -g @connectedyard/heroku-postico
-$ heroku plugins:install @connectedyard/heroku-postico
-$ heroku postico
+INSTALLATION
+  $ npm install -g @connectedyard/heroku-postico
+  $ heroku plugins:install @connectedyard/heroku-postico
+  $ heroku postico
 ```
@@ -22,7 +28,7 @@
 
-## `heroku postico:open`
+## heroku postico:open
 
-Fetch a list of Heroku postgres databases for a team and connect in Postico.
+Fetch Heroku postgres databases for a team to choose from a list and connect in Postico.
 
-```
+```sh-session
 USAGE
@@ -32,7 +38,27 @@ $ heroku postico:open --team=[your heroku team]
 
+![](readme-assets/postico-open-small.gif)
 
+
+## heroku postico:export
+
+Export a folder containing Postico favorite files for all Heroku postgres databases associated with a team.
+
+```sh-session
+USAGE
+  $ heroku postico:export --team=[your heroku team]
+```
+
+![](readme-assets/postico-export-small.gif)
+
+Once the favorites are exported, drag & drop the folder onto the postico favorites window.
+
+:warning: :warning: :warning: Be sure to delete the exported 
+favorites folder permanently after importing to prevent leaking your passwords.
+
+
 # Developing
 
 1. Clone the repo.
-2. Link the heroku cli to your local working copy: `heroku plugins:link`.
-3. Run the command as usuable but running your local copy.
+2. CD into the repo and Link the heroku cli to your local working copy: `heroku plugins:link`.
+3. Make your edits and test your changes by running `heroku postico` as you normally would.
+4. Send us a PR and we'll review it.

src/commands/postico/export.js

@@ -29,3 +29,3 @@ const { Command, flags } = require('@heroku-cli/command')
 
-    static description = `Export postico favorites for all postgres addons for a team`
+    static description = `Export a folder containing Postico favorite files for all Heroku postgres databases associated with a team.`
 
@@ -32,0 +32,0 @@ static flags = {

src/commands/postico/open.js

@@ -10,3 +10,3 @@ const { Command, flags } = require('@heroku-cli/command')
 
-    static description = `Fetch a list of Heroku postgres databases for a team and connect in Postico`
+    static description = `Fetch Heroku postgres databases for a team to choose from a list and connect in Postico.`
 
@@ -13,0 +13,0 @@ static flags = {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11125

increased by10.92%

Number of lines in readme file

62

increased by72.22%

No dependency changes