Skip to content

Latest commit

 

History

History
206 lines (146 loc) · 6.44 KB

README.md

File metadata and controls

206 lines (146 loc) · 6.44 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Wordle++

Making Wordle modding easier than before.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: Roizor, wordle-plus-plus, twitter_handle, linkedin_username, email_client, email, Wordle++, Making Wordle modding easier than before.

(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.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/Roizor/wordle-plus-plus.git
  2. Install NPM packages 
    npm install
  3. Build Wordle++ 
    npm run build
  4. Create a bookmark in your browser

(back to top)

Usage

Once Wordle++ is installed, your theme & it's source is packed into one. Navigate to Wordle (on NYT), press the bookmark, and watch the magic unfold. Theme GIF

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Stable injection method
  • Feature 2
  • Feature 3
    • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/Roizor/wordle-plus-plus

(back to top)

Acknowledgments

(back to top)