diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 65cf5bb..ccb9e57 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 55ee2ac..6b60b38 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,6 +5,9 @@ updates: directory: '/' schedule: interval: 'weekly' + day: 'monday' + time: '07:00' + timezone: 'Europe/Amsterdam' open-pull-requests-limit: 10 labels: - 'dependencies' @@ -18,6 +21,9 @@ updates: directory: '/' schedule: interval: 'weekly' + day: 'monday' + time: '07:00' + timezone: 'Europe/Amsterdam' open-pull-requests-limit: 10 labels: - 'dependencies' diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..590c7da --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,37 @@ +# .github/release.yml +# Configuration for GitHub's automatically generated release notes +# Reference: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes + +changelog: + exclude: + labels: + - ignore-for-release + authors: + - dependabot + categories: + - title: ๐Ÿš€ New Features + labels: + - enhancement + - feature + - title: ๐Ÿ› Bug Fixes + labels: + - bug + - bugfix + - fix + - title: ๐Ÿ“š Documentation + labels: + - documentation + - title: ๐Ÿงช Tests + labels: + - test + - testing + - title: ๐Ÿ”ง Maintenance + labels: + - chore + - maintenance + - title: โฌ†๏ธ Dependencies + labels: + - dependencies + - title: ๐Ÿงฐ Other Changes + labels: + - "*" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d3c3bd1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Kaj "kjanat" Kowalski + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index f10b786..4c3aa50 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ A Go-based parser that converts Articulate Rise e-learning content to various formats including Markdown and Word documents. +[![Go version](https://img.shields.io/github/go-mod/go-version/kjanat/articulate-parser?logo=Go&logoColor=white)][gomod] + + +[![Tag](https://img.shields.io/github/v/tag/kjanat/articulate-parser?sort=semver&label=Tag)][Tags] +[![Release Date](https://img.shields.io/github/release-date/kjanat/articulate-parser?label=Release%20date)][Latest release] +[![License](https://img.shields.io/github/license/kjanat/articulate-parser?label=License)](LICENSE) +[![Commit activity](https://img.shields.io/github/commit-activity/m/kjanat/articulate-parser?label=Commit%20activity)][Commits] +[![Last commit](https://img.shields.io/github/last-commit/kjanat/articulate-parser?label=Last%20commit)][Commits] +[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/kjanat/articulate-parser?label=Issues)][Issues] +[![CI](https://img.shields.io/github/actions/workflow/status/kjanat/articulate-parser/ci.yml?logo=github&label=CI)][Build] +[![Codecov](https://img.shields.io/codecov/c/gh/kjanat/articulate-parser?token=eHhaHY8nut&logo=codecov&logoColor=%23F01F7A&label=Codecov)][Codecov] + ## Features - Parse Articulate Rise JSON data from URLs or local files @@ -140,6 +152,14 @@ The parser includes error handling for: - File I/O errors - Unsupported content types + + ## Limitations - Media files (videos, images) are referenced but not downloaded @@ -161,3 +181,13 @@ Potential improvements could include: ## License This is a utility tool for educational content conversion. Please ensure you have appropriate rights to the Articulate Rise content you're parsing. + +[Build]: https://github.com/kjanat/articulate-parser/actions/workflows/ci.yml +[Codecov]: https://codecov.io/gh/kjanat/articulate-parser +[Commits]: https://github.com/kjanat/articulate-parser/commits/master/ +[Go report]: https://goreportcard.com/report/github.com/kjanat/articulate-parser +[gomod]: go.mod +[Issues]: https://github.com/kjanat/articulate-parser/issues +[Latest release]: https://github.com/kjanat/articulate-parser/releases/latest +[Package documentation]: https://godoc.org/github.com/kjanat/articulate-parser +[Tags]: https://github.com/kjanat/articulate-parser/tags diff --git a/go.mod b/go.mod index 11f8d80..23a7d1f 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module articulate-parser +module github.com/kjanat/articulate-parser go 1.21