Add documentation (#5)

* test public orb

* override doc

* cleanup

* updated description

* nl yml

.circleci/test-deploy.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  stale-md: mkotsollaris/stale-md@dev:<<pipeline.git.revision>>
+  stale-md: mkotsollaris/stale-md@0.0.3
   orb-tools: circleci/orb-tools@11.1
 
 filters: &filters

README.md

@@ -4,17 +4,29 @@
 
 Find stale documentation through CI.
 
-`stale.md` is a CircleCI orb that identifies stale documentation (ie 90 days of unchanged `.md` file) and warns developers on maintaining their documentation.
+`stale-md` is a CircleCI orb that identifies stale documentation (ie 90 days of unchanged `.md` file) and warns developers on maintaining their documentation.
 
 # Usage
 
 ```bash
-@orb reference TBD
-
-description: >
-  Identify Stale Documentation
-steps:
-  - stale.md/scan
+version: 2.1
+
+orbs:
+  stale-md: mkotsollaris/stale-md@0.0.3
+  orb-tools: circleci/orb-tools@11.1
+
+jobs:
+  scan:
+    docker:
+      - image: cimg/base:current
+    steps:
+      - checkout
+      - stale-md/scan
+
+workflows:
+  main:
+    jobs:
+      - scan
 ```
 
 # Options

src/@orb.yml

@@ -1,14 +1,7 @@
 version: 2.1
 
 description: >
-  Sample orb description Sample orb description Sample orb description Sample orb description
-# What will your orb allow users to accomplish?
-# Descriptions should be short, simple, and informative.
+  Find stale documentation through CI. `stale-md` is a CircleCI orb that identifies stale documentation (ie 90 days of unchanged `.md` file) and warns developers on maintaining their documentation.
 
-# This information will be displayed in the orb registry and is not mandatory.
 display:
   source_url: "https://github.com/mkotsollaris/stale-md.git"
-
-# If your orb requires other orbs, you can import them like this. Otherwise remove the "orbs" stanza.
-# orbs:
-#  hello: circleci/hello-build@0.0.5

src/examples/example.yml

@@ -1,13 +1,25 @@
 description: >
-  Sample example description.
-# Provide a use-case based example for using this orb.
-# Everything in the `usage` section will be displayed in the orb registry.
-# Comments are not retained.
+  `stale-md/scan` usage
+
 usage:
   version: 2.1
-  orbs:
-    <orb-name>: <namespace>/<orb-name>@1.2.3
-  workflows:
-    use-my-orb:
-      jobs:
-        - <orb-name>/<job-name>
+
+orbs:
+  stale-md: mkotsollaris/stale-md@0.0.3
+  orb-tools: circleci/orb-tools@11.1
+
+jobs:
+  scan:
+    docker:
+      - image: cimg/base:current
+    environment:
+      IGNORED_FILES: "./.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md EXAMPLE.md" # declare files to be ignored during scan
+      DAYS_THRESHOLD: 50 # this overrides the default value of 90 days
+    steps:
+      - checkout
+      - stale-md/scan
+
+workflows:
+  main:
+    jobs:
+      - scan