A-hex-🕘
a-hex-clock is a feature
that allows everyone
to easily add a color changing real-time clock to anywhere on their website or app
.
As time goes by the clock will change according to the hex code displayed.
Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of
npm
- You have installed the latest version of
node.js
Installing <a_hex_clock>
To install, type this in your terminal:
$ npm init
$ npx a-hex-clock
Afterwards you are going to want copy the code to your desired location of the module. Here's the src link's for stylesheet and script - just to save you some time ;)
<link rel="stylesheet" href="../css/hexClock.css">
<script src="../js/hexClock.js" defer></script>
if above doesn't work:
<link rel="stylesheet" href="./src/css/hexClock.css">
<script src="./src/js/hexClock.js" defer></script>
comments will explain where you can apply your own styling / theme.
Contributing to this project
To contribute to A Hex 🕘, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
License
This project uses the following license: MIT.
clock is ready in it's basic form - more themes will be added