diff --git a/README.md b/README.md new file mode 100644 index 0000000..d62fc16 --- /dev/null +++ b/README.md @@ -0,0 +1,126 @@ +# GCalendar-Visuals + +A repository to list and display Google Calendar codewords with images and titles, organized in visual cards. Perfect for easy reference and quick use. + +## Table of Contents + +1. [Introduction](#introduction) +2. [Features](#features) +3. [Usage](#usage) +4. [Codewords](#codewords) +5. [Contributing](#contributing) +6. [License](#license) + +## Introduction + +Google Calendar codewords are a powerful way to organize and beautify your events. **GCalendar-Visuals** provides an easy-to-navigate interface with visually appealing cards that display codewords alongside related images and titles for better comprehension and use. + +## Features + +- **Visual Cards**: Each codeword is presented with a title, related image, and associated keywords. +- **Simplified Search**: Quickly find codewords for specific types of events. +- **Creative Organization**: Add flair and creativity to your Google Calendar events effortlessly. +- **User-Friendly Interface**: Clean, intuitive design for ease of access. + +## Usage + +Using Google Calendar codewords is simple! Follow these steps to enhance your events: + +1. Select a codeword from the list. +2. Add the codeword to your event's title using the format `%codeword%`. For example: + - **Input**: `Team Meeting %brainstorm%` + +3. When viewed in Google Calendar, the event will display: + - The original title, such as "Team Meeting". + - A **background image** representing the codeword (e.g., a light bulb for brainstorming). + +This visual enhancement helps identify event types at a glance. + +## Codewords + +
+ Sports + | Codeword | Synonyms | Example Usage | Image Placeholder | + |-----------------|----------------------------------|-----------------------|--------------------------| + | **%football%** | %soccer%, %american football% | `Game %football%` | ![Football](./images/football.jpg) | + | **%basketball%**| %hoops%, %bball% | `Practice %basketball%`| ![Basketball](./images/basketball.jpg) | + | **%boxing%** | %fight%, %punch% | `Training %boxing%` | ![Boxing](./images/boxing.jpg) | + | **%rugby%** | %football%, %union% | `Play %rugby%` | ![Rugby](./images/rugby.jpg) | +
+ +
+ Outdoor Activities + | Codeword | Synonyms | Example Usage | Image Placeholder | + |-----------------|----------------------------------|-----------------------|--------------------------| + | **%hiking%** | %trekking%, %walking% | `Weekend %hiking%` | ![Hiking](./images/hiking.jpg) | + | **%cycling%** | %biking%, %bicycle% | `Enjoy %cycling%` | ![Cycling](./images/cycling.jpg) | + | **%camping%** | %tenting%, %outdoor% | `Go %camping%` | ![Camping](./images/camping.jpg) | + | **%kayaking%** | %canoeing%, %paddling% | `Try %kayaking%` | ![Kayaking](./images/kayaking.jpg) | +
+ +
+ Celebrations + | Codeword | Synonyms | Example Usage | Image Placeholder | + |-----------------|----------------------------------|-----------------------|--------------------------| + | **%christmas%** | %xmas%, %holiday% | `Celebrate %christmas%`| ![Christmas](./images/christmas.jpg) | + | **%birthday%** | %party%, %celebration% | `John's %birthday%` | ![Birthday](./images/birthday.jpg) | + | **%wedding%** | %marriage%, %nuptials% | `Plan the %wedding%` | ![Wedding](./images/wedding.jpg) | +
+ +
+ Leisure & Relaxation + | Codeword | Synonyms | Example Usage | Image Placeholder | + |-----------------|----------------------------------|-----------------------|--------------------------| + | **%coffee%** | %latte%, %brew% | `Enjoy a %coffee%` | ![Coffee](https://ssl.gstatic.com/calendar/images/eventillustrations/2024_v1/img_coffee.svg) | + | **%reading%** | %books%, %literature% | `Read a %book%` | ![Reading](https://ssl.gstatic.com/calendar/images/eventillustrations/2024_v1/img_read.svg) | + | **%relaxing%** | %chilling%, %unwinding% | `Spend time %relaxing%`| ![Relaxing](https://ssl.gstatic.com/calendar/images/eventillustrations/2024_v1/img_art.svg) | +
+ +
+ Arts & Crafts + | Codeword | Synonyms | Example Usage | Image Placeholder | + |-----------------|----------------------------------|-----------------------|--------------------------| + | **%painting%** | %art%, %canvas% | `Create %painting%` | ![Painting](./images/painting.jpg) | + | **%crochet%** | %knitting%, %threadwork% | `Learn to %crochet%` | ![Crochet](./images/crochet.jpg) | + | **%embroidery%**| %stitching%, %needlework% | `Practice %embroidery%`| ![Embroidery](./images/embroidery.jpg) | +
+ +
+ Cooking & Dining + | Codeword | Synonyms | Example Usage | Image Placeholder | + |-----------------|----------------------------------|-----------------------|--------------------------| + | **%cooking%** | %meal prep%, %chef% | `Prepare some %cooking%`| ![Cooking](./images/cooking.jpg) | + | **%bbq%** | %barbecue%, %grill% | `Host a %bbq%` | ![BBQ](./images/bbq.jpg) | + | **%brunch%** | %breakfast lunch%, %midday meal% | `Enjoy a %brunch%` | ![Brunch](./images/brunch.jpg) | +
+ +
+ Fitness & Wellness + | Codeword | Synonyms | Example Usage | Image Placeholder | + |-----------------|----------------------------------|-----------------------|--------------------------| + | **%yoga%** | %stretch%, %meditation% | `Start %yoga% today` | ![Yoga](./images/yoga.jpg) | + | **%crossfit%** | %fitness%, %workout% | `Join a %crossfit% class` | ![Crossfit](./images/crossfit.jpg) | + | **%massage%** | %relax%, %therapy% | `Book a %massage%` | ![Massage](./images/massage.jpg) | +
+ +
+ Technology & Learning + | Codeword | Synonyms | Example Usage | Image Placeholder | + |-----------------|----------------------------------|-----------------------|--------------------------| + | **%coding%** | %programming%, %development% | `Learn %coding%` | ![Coding](./images/coding.jpg) | + | **%hackathon%** | %coding event%, %competition% | `Join the %hackathon%`| ![Hackathon](./images/hackathon.jpg) | + | **%computer science%** | %IT%, %technology% | `Study %computer science%` | ![Computer Science](./images/computer_science.jpg) | +
+ + +## Contributing + +We welcome contributions! To get started: + +1. Fork the repository. +2. Create a new branch for your feature or bug fix. +3. Commit your changes and open a pull request. + +## License + +This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.