Merge pull request #36 from astaiglesia/documentation

Documentation Maintenance PR

Author: bielchristo

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 spearmintjs
+Copyright (c) 2019-2021 spearmintjs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,10 +2,14 @@
 
 Spearmint helps developers easily create functional React/Redux/Endpoint/Paint Timing tests without writing any code. It dynamically converts user inputs into executable Jest test code by using DOM query selectors provided by @testing-library.
 
-## How to use
+# How to use
 
 Download spearmint @ spearmintjs.com. Available for Mac OS and Windows.
 
+<br>
+
+### React Testing
+<hr>
 To run React tests generated by spearmint, install the following in your dev dependencies.
 
     npm i -D jest @testing-library/jest-dom @testing-library/react test-data-bot
@@ -18,15 +22,44 @@ To run Hooks / Context tests generated by spearmint, install the following in yo
 
     npm i -D @testing-library/react-hooks
 
+<br>
+
+### Endpoint Testing
+<hr>
 To run Endpoint tests generated by spearmint, install the following in your dev dependencies.
 
     npm i -D jest supertest
 
+<br>
+
+### Puppeteer Testing
+<hr>
 To run Puppeteer tests generated by spearmint, install the following in your dev dependencies.
 
     npm i -D jest puppeteer
 
-## How it works
+
+<br>
+
+### Accessiblity Testing
+<hr>
+
+To run Accessibility tests generated by spearmint on HTML, install the following in your dev dependencies.
+
+    npm i -D axe-core regenerator-runtime jest
+
+To run Accessibility tests generated by spearmint on React Components, install the following in your dev dependencies.
+
+    npm i -D axe-core regenerator-runtime jest enzyme enzyme-adapter-react-16
+
+To run Accessibility tests generated by spearmint on URL's with Puppeteer, install the following in your dev dependencies.
+
+    npm i -D axe-core puppeteer
+
+
+<br>
+
+# How it works
 
 1.  On the initial screen, enter the URL of your project and load your application to start creating tests.
 
@@ -42,24 +75,33 @@ To run Puppeteer tests generated by spearmint, install the following in your dev
 
 ![](/public/testfile.png?raw=true)
 
-## Team
+<br>
+
+### The Spearmint Team
+<hr>
 
 > Alex [@apark0720](https://github.com/apark0720) &nbsp;&middot;&nbsp;
+> Alfred  [@astaiglesia](https://github.com/astaiglesia) &nbsp;&middot;&nbsp;
+> Annie  [@annieshinn](https://github.com/annieshinn) &nbsp;&middot;&nbsp;
 > Ben [@bkwak](https://github.com/bkwak) &nbsp;&middot;&nbsp;
-> Charlie [@charlie-maloney](https://github.com/charlie-maloney) &nbsp;&middot;&nbsp;
-> Chloe [@HeyItsChloe](https://github.com/HeyItsChloe) <br />
+> Charlie [@charlie-maloney](https://github.com/charlie-maloney) <br />
+> Chloe [@HeyItsChloe](https://github.com/HeyItsChloe) &nbsp;&middot;&nbsp;
 > Cornelius [@corneeltron](https://github.com/corneeltron)  &nbsp;&middot;&nbsp;
 > Dave [@davefranz](https://github.com/davefranz) &nbsp;&middot;&nbsp;
 > Evan [@Berghoer](https://github.com/Berghoer) &nbsp;&middot;&nbsp;
-> Johnny [@johnny-lim](https://github.com/johnny-lim) <br />
+> Gabriel  [@bielchristo](https://github.com/bielchristo) <br />
+> Johnny [@johnny-lim](https://github.com/johnny-lim) &nbsp;&middot;&nbsp;
 > Julie [@julicious100](https://github.com/julicious100) &nbsp;&middot;&nbsp;
 > Karen [@karenpinilla](https://github.com/karenpinilla) &nbsp;&middot;&nbsp;
 > Linda [@lcwish](https://github.com/lcwish) &nbsp;&middot;&nbsp;
 > Luis [@Luis-KM-Lo](https://github.com/Luis-KM-Lo) <br />
 > Mike [@mbcoker](https://github.com/mbcoker) &nbsp;&middot;&nbsp;
 > Natlyn [@natlynp](https://github.com/natlynp) &nbsp;&middot;&nbsp;
 > Nick [@nicolaspita](https://github.com/nicolaspita) &nbsp;&middot;&nbsp;
-> Rachel [@rachethecreator](https://github.com/rachethecreator) <br />
-> Sean [@sean-haverstock](https://github.com/Sean-Haverstock) &nbsp;&middot;&nbsp;
+> Rachel [@rachethecreator](https://github.com/rachethecreator) &nbsp;&middot;&nbsp;
+> Sean [@sean-haverstock](https://github.com/Sean-Haverstock) <br />
+> Sharon [@sharon-zhu](https://github.com/sharon-zhu) &nbsp;&middot;&nbsp;
 > Sieun [@sieunjang](https://github.com/sieunjang) &nbsp;&middot;&nbsp;
-> Tristen [@twastell](https://github.com/twastell) 
+> Tolan [@taoantaoan](https://github.com/taoantaoan) &nbsp;&middot;&nbsp;
+> Tristen [@twastell](https://github.com/twastell) <br />
+<hr>

todoDemo.mov deprecated files/todoDemo.movtodoDemo.mov renamed to deprecated files/todoDemo.mov

@@ -61,6 +61,30 @@ const About = ({ dispatch: dispatchToGlobal }: { dispatch: (action: Action) => v
         <pre>
           <code>npm i -D jest puppeteer</code>
         </pre>
+        
+     
+        <p>
+          To run Accessibility tests generated by spearmint on HTML, install the following in your dev dependencies.
+        </p>
+        <pre>
+          <code>npm i -D axe-core regenerator-runtime jest</code>
+        </pre>
+
+        <p>
+          To run Accessibility tests generated by spearmint on React Components, install the following in your dev dependencies.
+        </p>
+        <pre>
+          <code>npm i -D axe-core regenerator-runtime jest enzyme enzyme-adapter-react-16</code>
+        </pre>
+
+        <p>
+          To run Accessibility tests generated by spearmint on URL's with Puppeteer, install the following in your dev dependencies.
+        </p>
+        <pre>
+          <code>npm i -D axe-core puppeteer</code>
+        </pre>
+
+
         <h2>How it works</h2>
         <ol>
           <li>
@@ -104,9 +128,14 @@ const About = ({ dispatch: dispatchToGlobal }: { dispatch: (action: Action) => v
         <p>
           <img src={image2} alt='' />
         </p>
-        <h2>Team</h2>
+        <h2>The Spearmint Team</h2>
         <blockquote>
           <p>
+            Alfred <a href='https://github.com/astaiglesia'>@staiglesia</a>  ·  Annie{' '}
+            <a href='https://github.com/annieshinn'>@annieshinn</a>  ·  Gabriel{' '}
+            <a href='https://github.com/bielchristo'>@bielchristo</a>  ·  Sharon{' '}
+            <a href='https://github.com/sharon-zhu'>@sharon-zhu</a>  ·  Tolan{' '}
+            <a href='https://github.com/taoantaoan'>@taoantaoan</a> <br></br>
             Ben <a href='https://github.com/bkwak'>@bkwak</a>  ·  Evan{' '}
             <a href='https://github.com/Berghoer'>@Berghoer</a>  ·  Nicolas{' '}
             <a href='https://github.com/nicolaspita'>@nicolaspita</a>  ·  Luis{' '}