Skip to content

Improve readme file #257

@jesper-friis

Description

@jesper-friis

Most users of oteapi-services would like to run it with Docker Compose in production mode. Place that section on top of the readme.

A more logical structure of the readme would be:

  • One-liner - "A RESTfull interface to OTEAPI" + illustrative figure
  • Table of content
  • About oteapi-services
  • Using oteapi
    • Run oteapi-services
    • OTEAPI Plugin Repositories
  • For developers
    • Run oteapi-services as developer
    • For plugin developers
  • Acknowledgements
  • License

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions