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

Enhance the README.md file #18

Closed
2 tasks done
cmoulliard opened this issue Oct 24, 2022 · 3 comments · Fixed by #65
Closed
2 tasks done

Enhance the README.md file #18

cmoulliard opened this issue Oct 24, 2022 · 3 comments · Fixed by #65
Assignees
Labels
enhancement New feature or request

Comments

@cmoulliard
Copy link
Contributor

cmoulliard commented Oct 24, 2022

TODO

  • Enhance the README.md file to explain how to claim or register a service
  • Add a developer page to explain how to create a front screen (form, list, etc) and map the actions with REST endpoints
@cmoulliard cmoulliard changed the title Enhance the README.md file to explain how to claim or register a service and search Enhance the README.md file Oct 24, 2022
@Sgitario
Copy link
Collaborator

Sgitario commented Oct 28, 2022

Some other items that should be addressed in the README.md file:

  • Explain the purpose of the project, before even explaining the project name.
  • The Related Guides section in the README.md file (https://github.com/halkyonio/primaza-poc#related-guides) mentions Resteasy Reactive and this project is not using it. It's using Resteasy Classic. I'm not sure if using Resteasy Classic was intentional or not. If not, I'm happy to add the necessary changes to use Resteasy Reactive as part of a separate PR.

cc @cmoulliard @aureamunoz

@cmoulliard
Copy link
Contributor Author

  • Explain the purpose of the project, before even explaining the project name.

+1

  • mentions Resteasy Reactive and this project is not using it. It's using Resteasy Classic. I'm not sure if using Resteasy Classic was intentional or not. If not, I'm happy to add the necessary changes to use Resteasy Reactive as part of a separate PR.

Do we have to use Resteasy reactive (pro, added value, ...) ? If no, then remove such a wording from the text.

aureamunoz added a commit to aureamunoz/servicebox-poc that referenced this issue Nov 4, 2022
@aureamunoz
Copy link
Contributor

See #68 for the second task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants