Skip to content

manoj-dhakal/explainium

Repository files navigation

Welcome to Explainium! 🧡✨

Hey there! 👋 Welcome to the official Explainium repository. We're super excited to have you here! 🎉

Explainium is your friendly sidekick for making sense of complex text. Whether you're reading a website or a PDF, just select any word, sentence, or paragraph, and let Explainium explain it in two ways:

  1. ELI5 (Explain Like I'm 5): Simplified, super easy to understand explanations. 🌈
  2. Pro-Level: Detailed, in-depth explanations for those who want to dive deeper! 🔍

💻 How Does It Work?

Explainium is a Chrome Extension that uses the power of Google's Prompt API to offer smart explanations right alongside your reading. It appears as a side panel, making it easy to get instant explanations, whether you're studying or just curious! 🤓

✨ Features:

  • ELI5 Mode: Super simple explanations for anyone and everyone. 🧸
  • Pro-Level Mode: For when you want all the nitty-gritty details. 🔬
  • Seamless Integration: Works on websites and PDFs. Just select any text and you're good to go! 📄
  • Side Panel: Always there, ready to help when you need it. 🦸‍♀️🦸‍♂️

🚀 How to Get Started

  1. Clone this repository to your local machine. 🖥️

    git clone https://github.com/manoj-dhakal/explainium.git
  2. Open Google Chrome and go to chrome://extensions.

  3. Turn on Developer Mode (top-right corner).

  4. Click Load unpacked and select the folder where you cloned Explainium.

  5. You're all set! Select any text on a webpage or PDF, and Explainium will appear with helpful explanations. 🎈


📝 Contributing

Want to help make Explainium even more awesome? We love pull requests! 💕 Here's how you can contribute:

  1. Fork the repo 🍴
  2. Make your changes ✨
  3. Submit a pull request. We’ll be sure to give you some kudos! 🎉

Video

More about explainium in this video: https://youtu.be/TrCvHbBmmzA?si=ejSqGSLOZwi0G_HA

📬 Contact

Have questions or ideas? Feel free to open an issue or reach out to us! We’d love to hear from you! 📣


🎉 Thanks for visiting Explainium! 🎉

We hope Explainium makes your reading easier, more fun, and super interesting. Enjoy exploring and explaining! 🌍💡

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages