cli-circle

Generate ASCII circles with NodeJS.

☁️ Installation

# Using npm 
npm install --save cli-circle
 
# Using yarn 
yarn add cli-circle

📋 Example

const circle = require("cli-circle");
 
// Output the circle
console.log(circle(5).toString());
// =>       • • • • •
//        •           •
//      •               •
//    •                   •
//    •                   •
//    •                   •
//    •                   •
//    •                   •
//      •               •
//        •           •
//          • • • • •
//

❓ 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

CliCircle(radius, chr, opts)

Creates a new instance of CliCircle.

Params

• Number radius: The radius value.
• String chr: The character used for drawing the circle (default: ".").
• Object opts: Options passed to the CliGraph constructor.

Return

• CliCircle The CliCircle instance containing:
• radius (Number): The circle radius.
• diameter (Number): The circle diameter.
• chr (String): The point character.
• graph (CliGraph): The graph instance.

toString()

Stringifies a circle.

Return

• String The stringified circle.

😋 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! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• cli-pie

📜 License

MIT © Ionică Bizău