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

Update USAGE.md #10

Merged
merged 4 commits into from
Dec 10, 2022
Merged

Conversation

bocops
Copy link
Collaborator

@bocops bocops commented Dec 7, 2022

This addresses some of the shortcomings mentioned in #9. However, three of the existing sections are not updated by this PR and probably should be checked/updated as well - see TODO below.

  • remove "public timeline" example; no longer works
  • replace specific hostname with instanceHostname variable that is explained in Prerequisites
  • replace example client website with "example.org"
  • add section to get access token from user credentials directly
  • add section to post a status

TODO: following sections untouched/unchecked

  • Using OAuth
  • Get raw json
  • Streaming API

- remove "public timeline" example; no longer works
- replace specific hostname with instanceHostname variable that is explained in Prerequisites
- replace example client website with "example.org"
- add section to get access token from user credentials directly
- add section to post a status

TODO: following sections untouched/unchecked
- Using OAuth
- Get raw json
- Streaming API
- copyedit "Using OAuth" (login) section, adding some more comments
- explaining our use of out-of-band redirect_uri in this guide
- mentioning that less than full scope should generally be requested
@codecov
Copy link

codecov bot commented Dec 8, 2022

Codecov Report

Base: 0.00% // Head: 0.00% // No change to project coverage 👍

Coverage data is based on head (253fcf8) compared to base (c19e7a3).
Patch has no changes to coverable lines.

❗ Current head 253fcf8 differs from pull request most recent head 87045a7. Consider uploading reports for the commit 87045a7 to get more accurate results

Additional details and impacted files
@@     Coverage Diff      @@
##   master   #10   +/-   ##
============================
============================

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

moving comments in front of variable/value they are about
switch to named arguments in remaining Kotlin code examples for better readability
@andregasser andregasser merged commit 1508e73 into andregasser:master Dec 10, 2022
@andregasser
Copy link
Owner

@bocops Thanks again for your contribution! Sorry was busy the last few days. Trying to catch up!

@bocops bocops deleted the bocops-usage-update branch December 10, 2022 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants