readme

README.md

@@ -1 +1,37 @@
 # Equa11y
+
+### Welcome to equa11y, an easy to use command-line tool for accessiblity testing.
+
+#### To install:
+
+```
+npm i equa11y
+```
+
+#### To start:
+
+```
+npx equal
+```
+
+### Contribue
+
+##### Find us on [GitHub](https://github.com/oslabs-beta/equa11y)
+
+### More Information
+
+##### Find us on the [web](http://www.equa11y.com)
+
+### Authors
+
+##### Heather Friedman | [LinkedIn](https://www.linkedin.com/in/hgfriedman/) | [GitHub](https://github.com/heatherfriedman)
+
+##### Tjolanda Sullivan | [LinkedIn](https://www.linkedin.com/in/willhack/) | [GitHub](https://github.com/willhack)
+
+##### Taylor Riley Du | [LinkedIn](https://www.linkedin.com/in/taylorsriley/) | [GitHub](https://github.com/taylordu)
+
+##### Will Hack | [LinkedIn]() | [GitHub]()
+
+### License
+
+##### This project is licensed under MIT License.

package.json

@@ -1,6 +1,6 @@
 {
  "name": "equa11y",
- "version": "3.0.1",
+ "version": "4.0.3",
  "description": "",
  "main": "index.ts",
  "scripts": {
@@ -20,13 +20,24 @@
  "type": "git",
  "url": "git+https://github.com/oslabs-beta/Equa11y.git"
  },
- "keywords": [],
- "author": "",
- "license": "ISC",
+ "keywords": [
+ "accessibility",
+ "cli",
+ "testing",
+ "test",
+ "accessible",
+ "wcag",
+ "a11y",
+ "axe-core",
+ "TDD",
+ "BDD"
+ ],
+ "author": "Heather Friedman, Tjolanda Sullivan, Taylor Riley Du, Will Hack",
+ "license": "MIT",
  "bugs": {
  "url": "https://github.com/oslabs-beta/Equa11y/issues"
  },
- "homepage": "https://github.com/oslabs-beta/Equa11y#readme",
+ "homepage": "http://www.equa11y.com",
  "devDependencies": {
  "@types/axe-core": "^2.0.7",
  "@types/chalk": "^2.2.0",

src/index.ts

@@ -22,7 +22,8 @@ export const program: Program = {
  // Heading creation
  clear();
  CFonts.say('equa11y', {
- font: 'simple3d', space: false, 
+ font: 'simple3d',
+ space: false,
  gradient: ['#ff3333', 'magenta', '#00bebe'],
  transitionGradient: true,
  });
@@ -50,7 +51,8 @@ export const program: Program = {
  // Reset the display
  clear();
  CFonts.say('equa11y', {
- font: 'simple3d', space: false, 
+ font: 'simple3d',
+ space: false,
  gradient: ['#ff3333', 'magenta', '#00bebe'],
  transitionGradient: true,
  });