$ striking-clock

Build striking clock systems with JavaScript.

☁️ Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global striking-clock

# Using yarn
yarn global add striking-clock

Then, run striking-clock --help and see what the CLI tool can do.

$ striking-clock --help
Usage: striking-clock [options]

Build striking clock systems with JavaScript.

Options:
  -t, --time <time>        An optional time argument.
  -f, --sound-file <file>  The file path to the chiming sound.
  -h, --help               Displays this help.
  -v, --version            Displays version information.

Documentation can be found at https://github.com/IonicaBizau/striking-clock#readme.

📋 Example

Here is an example how to use this package as library. To install it locally, as library, you can use npm install striking-clock (or yarn add striking-clock):

const StrikingClock = require("striking-clock")

const DEFAULT_PATH = `${__dirname}/../lib/default.mp3`

const myClock = new StrikingClock({
    // Hourly
    "00:00": { path: DEFAULT_PATH, repeat: 12 }
  , "01:00": DEFAULT_PATH
  , "02:00": { path: DEFAULT_PATH, repeat: 2 }
  , "03:00": { path: DEFAULT_PATH, repeat: 3 }
  , "04:00": { path: DEFAULT_PATH, repeat: 4 }
  , "05:00": { path: DEFAULT_PATH, repeat: 5 }
  , "06:00": { path: DEFAULT_PATH, repeat: 6 }
  , "07:00": { path: DEFAULT_PATH, repeat: 7 }
  , "08:00": { path: DEFAULT_PATH, repeat: 8 }
  , "09:00": { path: DEFAULT_PATH, repeat: 9 }
  , "10:00": { path: DEFAULT_PATH, repeat: 10 }
  , "11:00": { path: DEFAULT_PATH, repeat: 11 }
})

myClock.auto("07:00")

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

For full API reference, see the DOCUMENTATION.md file.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! ❤️

📜 License

MIT © Ionică Bizău