Skip to content

Commit

Permalink
added basic header to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mateo-Wallace committed Mar 17, 2023
1 parent 333c718 commit b97f97e
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 4 deletions.
66 changes: 62 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,65 @@
# Rpg-Dice-Js
# IN DEVELOPMENT

Npm package that allows users to roll dice with all math and various forms of response
<a name="readme-top"></a>

## Settings
<!-- SHIELDS -->

`isBoldCrit, defaultDie, boldWrapper`
[![npm Downloads Shield](https://img.shields.io/npm/dm/rpg-dice-js?style=flat-square&logo=npm)]()
[![Stars Shield](https://img.shields.io/github/stars/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&color=blue&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/stargazers)
[![Forks Shield](https://img.shields.io/github/forks/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/network/members)
[![Contributors Shield](https://img.shields.io/github/contributors/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&color=success&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/graphs/contributors)
[![License Shield](https://img.shields.io/github/license/Mateo-Wallace/rpg-dice-js.svg?style=flat-square)](https://github.com/Mateo-Wallace/rpg-dice-js/blob/main/LICENSE)
[![LinkedIn Shield](https://img.shields.io/badge/LinkedIn-555555?style=flat-square&logo=linkedin)](https://www.linkedin.com/in/mateo-wallace/)

<!-- PROJECT LOGO & HEADER -->
<br />
<div align="center">
<img src="./img/rpg-dice-js-400.png" alt="rpg dice logo" width="80" height="80" style="border-radius: 50%">

<h3 align="center" style="font-size: 30px"><strong>rpg-dice-js</strong></h3>

<p align="center">
<strong>A dice roller for the modern javascript dev</strong>
<br />
With many settings options and response types for full customization
<br />
<br />
<a href="https://mateo-wallace.github.io/rpg-dice-js/">View Docs</a>
·
<a href="https://github.com/Mateo-Wallace/rpg-dice-js">View GitHub</a>
·
<a href="">View npm</a>
·
<a href="https://github.com/Mateo-Wallace/rpg-dice-js/issues">Report Bug</a>
</p>
</div>

<!-- TABLE OF CONTENTS -->

<details>
<summary style="cursor: pointer;"><strong>Table of Contents</strong></summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li><a href="#documentation">Documentation</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

<div align="center">
<br />
<img src="./src/img/dumbot-full-use-example.gif" alt="Example of Working Discord App">
<br />
<br />
</div>
Binary file added img/rpg-dice-js-400.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b97f97e

Please sign in to comment.