sky-snitch
v1.0.2
Published
A simple CLI weather app
Downloads
12
Readme
Perfect! Here's the updated README.md tailored to your CLI app now being called sky-snitch — fun, catchy, and still clear and professional:
☁️ sky-snitch
A snappy Node.js CLI app that "snitches" on the sky and tells you the weather — in style. Fetch real-time weather data straight from your terminal using the OpenWeatherMap API.
🌟 Why sky-snitch?
Because you deserve a fun, no-nonsense way to check the weather. Whether you're headed out or staying in, sky-snitch gives you accurate weather info... and a chuckle.
🖼️ Demo
$ weather
📍 Enter the city name: London
🏙️ City: London
🌡️ Temperature: 19°C
⛅ Weather: light rain
💧 Humidity: 68%
🍃 Wind Speed: 4.2 m/s🔧 Features
- 📍 City-based real-time weather lookup
- ⛅ Beautiful emoji-enhanced terminal output
- ⚡ Super fast and lightweight
- 🔧 Configurable with your own API key
- 🐧 Works cross-platform (Linux, Mac, Windows)
📦 Installation
🔹 Local Installation
git clone https://github.com/Lucid-Synth/sky-snitch.git
cd sky-snitch
npm installRun with:
node index.js🔹 Global Installation (Recommended)
To use sky-snitch anywhere from the terminal:
npm install -g .Then run:
weather🔐 API Key Setup
You need an OpenWeatherMap API key.
- Sign up at openweathermap.org/api
- Get your API key
- Create a
.envfile in the project root:
OPENWEATHER_API_KEY=your_api_key_here- Make sure the code includes:
import dotenv from 'dotenv';
dotenv.config();
const API_KEY = process.env.OPENWEATHER_API_KEY;📁 File Structure
sky-snitch/
├── index.js # Main CLI logic
├── .env # Your API key (not committed)
├── package.json # Project metadata
└── README.md # You're reading it!🧠 Future Ideas
- 📍 Auto-locate user via IP/geolocation
- 🌤️ Multi-day forecast support
- 🎨 Terminal color themes
- 🔄 Cache recent queries
- 🧪 Test mode (mock weather)
🛡 License
MIT License Made with ☕ by LucidSynth
🤝 Contributing
Got a better pun or a cool feature idea? Open a PR or issue and join the weather rebellion. sky-snitch welcomes your forecasts!
Let me know if you want to regenerate a CLI ASCII logo, add color with chalk, or support command-line args.
