diff --git a/README.md b/README.md new file mode 100644 index 0000000..bee6aa5 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# TIMECHEAT + +Welcome to TIMECHEAT, a web application crafted with appreciation and love for teams everywhere, streamlining the timesheet completion process. Developed by Jonatan Jansson in 2024, this tool is specially dedicated to the five-letter Portugal team, aiming to save time and reduce hassle in timesheet management. + +## Steps + +- **Copy from Previous:** Start by copying your pre-existing Excel timesheet tab for a previous month or use the template provided. +- **Easy Steps:** Simply move the bottom marked row beyond 32 steps or so and proceed to TIMECHEAT. +- **Customization:** Pick the year, month, and your holiday area with ease. +- **Instant Print:** Press "Print" to have the timesheet copied to your clipboard. Additionally, you could choose what you need from the printout in the div under the print button. +- **Smart Highlighting:** Then you paste that into your Excel, highlights weekends and holidays, making them easy to identify and modify in your spreadsheet. +- **Efficient Editing:** Use the Ctrl + H search and replace (weekend) and (holiday) to remove markers for a cleaner aesthetic. Boom, you're done and ready to log times for that month! + +## FAQ + +**Where did you gather the sources for the holidays?** +The holiday dates are sourced from the official spreadsheet for legal holidays for 2024, provided by the head of HR. + +**I think you may have missed a holiday?:** +The Weekend marker takes priority over the Holiday marker. It is likely that your holiday falls on a weekend for the current year. Unfortunately, this means it will not be marked separately as a holiday. + +## Getting Started + +To get started with TIMECHEAT, follow these simple steps: + +1. Ensure you have a copy of your timesheet for the previous month or use our provided template. +2. Access TIMECHEAT and enter the necessary details: year, month, and holiday area. +3. Press "Print" to have the timesheet ready. The data will be copied to your clipboard, and you can also select specific details from the printout provided. + +## Contributing + +We welcome contributions and suggestions to make TIMECHEAT even better for everyone. If you have ideas or feedback, please feel free to reach out or submit a pull request. + +## License + +MIT License + +Jonatan Jansson