Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify permissions requirements earlier in the documentation #226

Merged
merged 8 commits into from
Oct 9, 2024

Conversation

gopelkujo
Copy link
Contributor

@gopelkujo gopelkujo commented Oct 7, 2024

Resolves #225

What i have changed in README.md:

  • Move permission configuration section to before 'How to use' section
  • Fix some typos
  • Add comment in BackgroundLocation.startLocationService(); section
  • Improve explanation at getLocationUpdates section

Reference for markdown format Markdownlints Rules

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MoralCode
Copy link
Collaborator

Were you using an automatic tool to apply the markdownlint rules for this PR? if so it may be cool to set up this tool to run as a CI job to keep the docs to that standard in the future (in a separate PR though)

@MoralCode MoralCode changed the title Improve documentation Clarify permissions requirements earlier in the documentation Oct 8, 2024
@gopelkujo
Copy link
Contributor Author

gopelkujo commented Oct 9, 2024

Were you using an automatic tool to apply the markdownlint rules for this PR? if so it may be cool to set up this tool to run as a CI job to keep the docs to that standard in the future (in a separate PR though)

No i didn't, i use markdownlints extension in vscode. But i guess it's cool idea to do so. And but again there are risk to use automation implement rules such as remove unwanted doc, i guess maybe we can discuss it in an issue for later.

@MoralCode MoralCode merged commit 5f03e86 into Almoullim:master Oct 9, 2024
1 check passed
BWMuller pushed a commit to BWMuller/background_location that referenced this pull request Oct 13, 2024
…lim#226)

* Improve documentation

* Fix typos

* Improve explanation

* Add note for applying permission to info.plist

* Change flutter package get to flutter pub get

* Add placeholder and caution to add description in ios config

* Fix some typo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation
2 participants