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

[FEATURE REQ] Clean up the "Repository Contents" section of the README #309

Open
minas1 opened this issue Aug 12, 2024 · 0 comments
Open

Comments

@minas1
Copy link

minas1 commented Aug 12, 2024

The Repository Contents sections of the README is confusing. To an android developer like myself, it's not clear which sample I should consult in order to use the library in my app.

There's:

  1. notification-hubs-sample-app-java
  2. notification-hubs-sample-app-legacy
  3. FCMTutorialApp

For a new user of the library, the relevant one seems to be the last one (FCMTutorialApp). Whichever it is, it should be the first one in Repository Contents sections.

The rest should be below that one, preferably in a section with a lower heading.


Example:

Repository Contents

FCMTutorialApp
[...]

Legacy

notification-hubs-sample-app-java
[...]

notification-hubs-sample-app-legacy
[...]

Other

com.microsoft.windowsazure.messaging
[...]

notification-hubs-sdk-e2etestapp
[...]

@minas1 minas1 changed the title [FEATURE REQ] Clean up the "Repository Contents" of the README [FEATURE REQ] Clean up the "Repository Contents" section of the README Aug 12, 2024
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

No branches or pull requests

1 participant