ducksay-instant
Version:
A rewrite of cowsay using the DuckDuckGo Instant Answer API
56 lines (36 loc) • 2.23 kB
Markdown
# Ducksay
![An example use][logo]
[logo]: https://github.com/wkyleg/ducksay/blob/master/ducksay-screenshot.png?raw=true "Example usage"
## Introduction
**Ducksay Instant** brings the whimsy of unix utilities like [cowsay](https://en.wikipedia.org/wiki/Cowsay#:~:text=cowsay%20is%20a%20program%20that,the%20Penguin%2C%20the%20Linux%20mascot.) and [fortune](https://en.wikipedia.org/wiki/Fortune_(Unix)) into the modern era, leveraging the DuckDuckGo Instant Answer API. This novel twist allows your terminal's duck to do more than merely echo your input; it attempts to provide a concise answer to your queries. Whether you're looking for quick facts, definitions, or just a bit of terminal fun, Ducksay Instant is here to quack you up!
## Motivation
The motivation behind Ducksay Instant was to blend the charm of terminal-based ASCII art utilities with the functionality of modern APIs. It's a nod to the playful side of programming, while also offering a unique utility for fetching quick answers straight from your terminal.
## Features
- Instant answers to a wide range of questions, powered by the DuckDuckGo Instant Answer API.
- A friendly ASCII art duck that brings a touch of humor and personality to your terminal.
- Easy-to-use command-line interface for fast and fun interactions.
## Installation
To install Ducksay Instant globally on your system, simply run:
```bash
npm install -g ducksay-instant
```
This will install the package globally, allowing you to use ducksay from anywhere in your terminal.
## Usage
Using Ducksay Instant is as simple as typing:
```bash
ducksay <your question here>
```
### Example
```bash
ducksay who is Satoshi Nakamoto?
```
This will display an ASCII art duck alongside the answer to your question as fetched from DuckDuckGo Instant Answers.
### Examples
Here are some questions you might try:
- ducksay does p=np?
- ducksay what is the largest planet in the solar system?
- ducksay are you sentient?
## Contributing
Contributions are welcome! Whether you're looking to add more ASCII animals, enhance the functionality, or improve the documentation, your input is valued.
## License
ducksay-instant is released under the MIT License. See LICENSE for more details.