link2aws 1.0.0 → 1.0.5

package/README.md

@@ -2,16 +2,46 @@
 
 Copy/paste ARN, get direct link to AWS console
 
+<a href="https://link2aws.github.io">
+<img src="screenshot.png" alt="Screenshot of link2aws.github.io" />
+</a>
+
 Copyright (c) 2020, Felix Kaiser. License: [ISC](https://spdx.org/licenses/ISC.html)
 
+![Node.js CI](https://github.com/link2aws/link2aws.github.io/workflows/Node.js%20CI/badge.svg)
+
 ## How to...
 
-### Use interactively
+### Use as website
+
+Go to [link2aws.github.io](https://link2aws.github.io) (privacy notice: it runs in the browser and does *not* send your input anywhere)
+
+Or run directly from source:
+
+```sh
+# git clone https://github.com/link2aws/link2aws.github.io
+# firefox link2aws.github.io/index.html
+```
+
+### Use as command line tool
 
-* Online: go to [link2aws.github.io](https://link2aws.github.io) (privacy notice: it runs in the browser and does *not* send your input anywhere)
-* Self-hosted: clone the repo, open `index.html` in your browser (there is no build step)
+Via NPM:
 
-### Use via JavaScript API
+```sh
+# npm install -g link2aws
+# link2aws arn:aws:s3:::abcdefgh1234
+https://s3.console.aws.amazon.com/s3/buckets/abcdefgh1234
+```
+
+Or clone the repo and run the file (no setup required):
+
+```sh
+# git clone https://github.com/link2aws/link2aws.github.io
+# node link2aws.github.io/link2aws.js arn:aws:s3:::abcdefgh1234
+https://s3.console.aws.amazon.com/s3/buckets/abcdefgh1234
+```
+
+### Use as JavaScript library
 
 ```js
 var link2aws = require('link2aws');
@@ -19,10 +49,22 @@ new link2aws.ARN('arn:aws:s3:::abcdefgh1234').consoleLink
 // https://s3.console.aws.amazon.com/s3/buckets/abcdefgh1234
 ```
 
-If the ARN is invalid, or we valid but we have no link for it, an exception is thrown.
+Or:
+
+```js
+import { ARN } from 'link2aws';
+new ARN('arn:aws:s3:::abcdefgh1234').consoleLink;
+// https://s3.console.aws.amazon.com/s3/buckets/abcdefgh1234
+```
+
+If the ARN is invalid, or valid but we have no link for it, an exception is thrown.
 
 ### Add support for resource types
 
+It's super easy - see [this example](https://github.com/link2aws/link2aws.github.io/commit/0432ecbbe522dbbd7e746caeeb4a7d1a6be5f057).
+
+Pull requests welcome!
+
 #### Add code
 
 * Support for new resource types: see large dict at the end of `link2aws.js`

package/link2aws

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+let ARN = require("./link2aws.js").ARN;
+
+for (let i = 2; i < process.argv.length; i++) {
+    try {
+        console.log(new ARN(process.argv[i]).consoleLink);
+    } catch (e) {
+        console.error(e);
+    }
+}