sci-ndp / scidx-py

sciDX Science Data Exchange
Apache License 2.0
0 stars 1 forks source link

[Docs] Update README with New Library Functionalities #13

Closed rbardaji closed 3 months ago

rbardaji commented 3 months ago

Description

The current README file does not reflect the recent additions and changes to the library functionalities. It is essential to update the README to include the new functions and provide clear usage examples for users.

Tasks

  1. Add New Function Descriptions:

    • Register URL
    • Register S3
    • Register Kafka
    • Search Resource
  2. Update Existing Function Descriptions:

    • Ensure Register Organizations and Search Organizations are correctly documented.
  3. Provide Usage Examples:

    • Include examples for registering URL, S3, and Kafka resources.
    • Include examples for searching resources using the new search functionality.
  4. Update Installation and Configuration Sections:

    • Verify that installation instructions are up-to-date.
    • Ensure configuration examples include any necessary details for the new functionalities.
  5. Review and Update Testing Section:

    • Ensure the testing section aligns with the new functions and their respective tests.

Additional Context

Updating the README is crucial to ensure that users can effectively utilize the new features and understand how to interact with the updated library.

References

Refer to the recent commits and the following files for details on the new functionalities:

rbardaji commented 3 months ago

Done.