docs/api/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><h1><a href="https://travis-ci.com/ucsd-cse112/team13"><img src="https://travis-ci.com/ucsd-cse112/team13.svg?branch=master" alt="Build Status"></a>
<a href="https://badge.fury.io/js/friday-webcomponents"><img src="https://badge.fury.io/js/friday-webcomponents.svg" alt="npm version"></a>
<a href="https://codeclimate.com/github/ucsd-cse112/team13/maintainability"><img src="https://api.codeclimate.com/v1/badges/326f35bc460bb3deb322/maintainability" alt="Maintainability"></a>
<a href="https://codeclimate.com/github/ucsd-cse112/team13/test_coverage"><img src="https://api.codeclimate.com/v1/badges/326f35bc460bb3deb322/test_coverage" alt="Test Coverage"></a>
<a href="https://percy.io/ucsd-cse112/ucsd-cse112"><img src="https://percy.io/static/images/percy-badge.svg" alt="Visual Regression Testing."></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"></a></h1>
<h1 align="center"> Thank God It's Friday</h1>
<p align="center"> Welcome To UCSD-CSE112's Public Repository for Team Friday!</p>
<h4 align="center"> <img alt="Logo" src="https://imgur.com/e9SoakZ.png"></h4>
<h1>Table of contents</h1>
<!--ts-->
<ul>
<li><a href="#Table-of-contents">Table of Contents</a></li>
<li><a href="#Use-our-components">Use-out-components</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#Documentation">Documentation</a></li>
<li><a href="#Meet-The-Team">Meet The Team</a></li>
<li><a href="#Contributing">How to Contribute</a></li>
</ul>
<!--te-->
<h1>Use our components</h1>
<p>To download our components, simply run:
<code>npm i friday-webcomponents</code></p>
<p>Then, in your HTML page, include the components you want to use in the <code><head>...</head></code> tags. For example:</p>
<h3><core-hello></h3>
<pre class="prettyprint source lang-html"><code> <script src="./node_modules/friday-webcomponents/dist/core-hello.js"></script>
</code></pre>
<h3><core-slider></h3>
<pre class="prettyprint source lang-html"><code> <script src="./node_modules/friday-webcomponents/dist/core-slider.js"></script>
</code></pre>
<h3><core-tooltip></h3>
<pre class="prettyprint source lang-html"><code> <script src="./node_modules/friday-webcomponents/dist/core-tooltip.js"></script>
</code></pre>
<h3><core-link></h3>
<pre class="prettyprint source lang-html"><code> <script src="./node_modules/friday-webcomponents/dist/core-link.js"></script>
</code></pre>
<h1>Documentation</h1>
<h3>Confused about how to use our components ?</h3>
<p>See simple examples of our components <a href="https://github.com/ucsd-cse112/team13/blob/master/teamProfile.html">here</a>!<!-- todo --></p>
<h3>Read our API docs here</h3>
<p>See in-depth documentation <a href="https://github.com/ucsd-cse112/team13/blob/master/teamProfile.html">here</a>!</p>
<h1>Meet The Team</h1>
<p>This project could only be finished with the contribution of our members
<a href="https://github.com/ucsd-cse112/team13/blob/master/teamProfile.html">meet us</a>!</p>
<h1>Contributing</h1>
<p>If youre as passionate as we are, Thats all you need.
See our <a href="./CONTRIBUTING.md">How To Contribute</a> docs for simple steps!</p>
<p>Please make sure to update tests as appropriate.</p>
<p>#License
<a href="https://opensource.org/licenses/MIT">MIT</a></p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-CoreElement.html">CoreElement</a></li></ul><h3>Classes</h3><ul><li><a href="CoreByeElement.html">CoreByeElement</a></li><li><a href="CoreGreetElement.html">CoreGreetElement</a></li><li><a href="CoreHelloElement.html">CoreHelloElement</a></li><li><a href="CoreLinkElement.html">CoreLinkElement</a></li><li><a href="CoreSliderElement.html">CoreSliderElement</a></li><li><a href="CoreTooltipElement.html">CoreTooltipElement</a></li><li><a href="module-CoreElement-CoreElement.html">CoreElement</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Thu Jun 13 2019 17:27:01 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>