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.

Sign up for GitHub

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

Jump to bottom

Improvements to the README #9

Open
10 of 13 tasks
alex-berlin-tv opened this issue Jul 16, 2024 · 0 comments
Open
10 of 13 tasks

Improvements to the README #9

alex-berlin-tv opened this issue Jul 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@alex-berlin-tv
Copy link
Collaborator

alex-berlin-tv commented Jul 16, 2024 •
edited
Loading

The README should be comprehensive enough to provide a solid introduction to the package.

  • Give a first example Write walktrough
  • Explain pending changes on fields
  • Optional custom client for ORM-Model
  • Links to API-Documentation (more and check existing links)
  • Clarify the role and function of the user_field_names field
  • Document the installation of the package in the readme.
  • Complete example for Create, Update and Delete Fields
  • Document all ORM Methods
  • Explain Linked Row Caching
  • Tweak toc hint
  • Always use library example
  • Describe API-Client vs. ORM-Capabilities
  • toc hint
@alex-berlin-tv alex-berlin-tv added the documentation Improvements or additions to documentation label Jul 16, 2024
@alex-berlin-tv alex-berlin-tv changed the title Readme: Enhance Introduction Readme: Enhance Jul 16, 2024
@alex-berlin-tv alex-berlin-tv changed the title Readme: Enhance Improvements to the README Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alex-berlin-tv