BrowseEase

Streamline your browsing experience from the console with BrowseEase.

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Screenshots
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

There are many tools available for quick browsing, but BrowseEase was created as a streamlined solution to enhance your browsing experience directly from the console. Here’s why BrowseEase stands out:

• Efficiency at its core: This project is designed for users who want a faster way to open browsers and navigate to their favorite sites without manual typing.
• Clear and accessible code: The codebase is available for anyone to explore, showcasing how to implement simple command-line interactions in Python.
• User-friendly experience: Launch websites with just a few commands, making your browsing as easy and quick as possible.

This project is continually evolving. If you’d like to contribute or suggest improvements, feel free to check out the repository and get involved in simplifying browsing workflows!

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

1. Python

# For Windows
winget install Python.Python

# For macOS
brew install python

# For Linux (Debian-based)
sudo apt update
sudo apt install python3

2. After installation, you can verify that Python is installed by running:

   python --version  # or python3 --version on some systems

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/MohdAqdasAsim/BrowseEase.git

2. Create an Alias for Quick Access

   To set up an alias for the BrowseEase script, follow these instructions for your operating system:

   • Windows (Command Prompt)

     1. Open Command Prompt.
     2. Use the following command to create an alias (replace path_to_your_script with the actual path to your script):

        doskey browseease=python path_to_your_script/browseease.py $*

   • Linux and macOS

     1. Open a terminal.
     2. Edit your shell configuration file (e.g., ~/.bashrc or ~/.zshrc):

        nano ~/.bashrc  # or nano ~/.zshrc for Zsh users

     3. Add the following line at the end of the file (replace path_to_your_script with the actual path):

        alias browseease='python path_to_your_script/browseease.py'

     4. Save the file and exit the editor.
     5. Apply the changes by running:

        source ~/.bashrc  # or source ~/.zshrc for Zsh users

3. Verify the Alias

   After setting up the alias, you can verify it by running:

   browseease

(back to top)

Screenshots

Here are some more screenshots of the website:

(back to top)

Contributing

Contributions make the open-source community such an incredible place to learn, inspire, and innovate. Any contributions you make are greatly appreciated and help enhance this project.

If you have a suggestion to improve the project, feel free to fork the repo and submit a pull request. You can also open an issue with the "enhancement" tag. Don't forget to give the project a star if you find it helpful—thanks for your support!

Steps to Contribute:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Mohd Aqdas Asim - @mohdaqdasasim - [email protected]

Project Link: https://github.com/MohdAqdasAsim/BrowseEase

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Pages

(back to top)