Skip to content
New issue

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

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

Already on GitHub? # to your account

Refactoring the SDK structure to be more discoverable #29

Merged
merged 11 commits into from
Mar 9, 2024

Conversation

Tanz0rz
Copy link
Collaborator

@Tanz0rz Tanz0rz commented Mar 8, 2024

This is a large refactor of the overall structure to achieve two things:

  1. The code itself needed to be more discoverable for someone trying to understand how it works by browsing the project.
    • All non-required files were moved from the client package to the internal package to limit the noise when looking through the code
    • Methods that directly mapped to API endpoints were updated to match the underlying API path as closely as possible
  2. The docs were updated to simplify and streamline compiling an example program that uses the SDK
    • The development notes were moved to a DEVELOPMENT.md file
    • A LICENSE.txt file was added (and will be filled out soon)
    • The README.md was simplified
    • A CHANGELOG.md file was added to summarize the development of the project and link to all tagged releases
      • A top-level changelog was added to the project root which will link to all SDK changelogs

@Tanz0rz Tanz0rz merged commit 56af8b4 into main Mar 9, 2024
@Tanz0rz Tanz0rz deleted the feature/simplify-structure branch March 12, 2024 20:35
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant