Skip to content

Commit

Permalink
Add Changelog; Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
holybiber committed Jul 24, 2024
1 parent 7f7ee89 commit c6af38c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Changelog

## 0.8.0 - 2024-07-24
New features:
- Download PDF files as well and provide them offline
- Added sharing button and menu:
- Open PDF: Open the PDF on the device with the default app for PDFs
- Share PDF: Via the platform's share dialog
- Open in browser: Open the current worksheet on https://www.4training.net in the browser
- Share link: Share the link to the current worksheet on https://www.4training.net via the platform's share dialog

## 0.7.0 - 2023-12-22
- First published version (accepted into Google Play Store on 2023-12-24)
- Core functionality ready: 34 languages available for offline use, providing 27 different worksheets, language switcher, settings, onboarding, ...
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Both, the app and the website are projects by [holydevelopers.net](https://holyd
* The app works offline and displays only content that has been downloaded to the device. For each language we have a repository that is hosted on github. The location is `https://github.com/4training/html-languageCode`, for English it is https://github.com/4training/html-en.
* When the user decides to download a language, the contents of the corresponding repository are fetched with the [download_assets](https://pub.dev/packages/download_assets) package and stored on a folder on the device.
* The repository contains HTML files for each page, images and a JSON with the structure. It is generated by the `ResourcesBot` of our [pywikitools](https://github.com/4training/pywikitools) repository (see [ExportHTML](https://github.com/4training/pywikitools/blob/main/pywikitools/resourcesbot/export_html.py) and [ExportRepository](https://github.com/4training/pywikitools/blob/main/pywikitools/resourcesbot/export_repository.py))
* Additionally we download PDF files for easy sharing and printing. Similarly to the HTML repositories, we have a PDF repository for each language as well. The location is `https://github.com/4training/pdf-languageCode`, for English it is https://github.com/4training/pdf-en.

## License
Jesus says in Matthew 10:8, “Freely you have received; freely give.”
Expand Down Expand Up @@ -44,9 +45,9 @@ Before committing, please run the following commands and make sure they don't sh
## Contributing
By contributing you release your contributed code under the licensing terms explained above. Thank you!

Currently project management happens in our redmine. That's why you don't find issues here on github at the moment - contact us to get access.

## Roadmap
* **0.7**: Go to Google Play Store
* **0.8**: Provide PDF files as well for all worksheets
* **0.9**: Enable automatic updates (half-way implemented already but currently not operational - waiting for backend development to catch up)
* **1.0**: We're solid now and excited about the future

Expand Down

0 comments on commit c6af38c

Please sign in to comment.