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

1st Cleanup Week: Service Readme #743

Closed
17 of 18 tasks
Tracked by #744
Xuanwo opened this issue Sep 6, 2021 · 1 comment
Closed
17 of 18 tasks
Tracked by #744

1st Cleanup Week: Service Readme #743

Xuanwo opened this issue Sep 6, 2021 · 1 comment
Labels

Comments

@Xuanwo
Copy link
Contributor

Xuanwo commented Sep 6, 2021

Most of our services README is out of maintaining.

We need to add the following parts about it:

  • Useful badge, like what does in go-service-s3:
[![Build Status](https://github.com/beyondstorage/go-service-s3/workflows/Unit%20Test/badge.svg?branch=master)](https://github.com/beyondstorage/go-service-s3/actions?query=workflow%3A%22Unit+Test%22)
[![Integration Tests](https://teamcity.beyondstorage.io/app/rest/builds/buildType:(id:GoServiceS3_IntegrationTests)/statusIcon)](https://teamcity.beyondstorage.io/buildConfiguration/GoServiceS3_IntegrationTests)
[![License](https://img.shields.io/badge/license-apache%20v2-blue.svg)](https://github.com/Xuanwo/storage/blob/master/LICENSE)
[![](https://img.shields.io/matrix/beyondstorage@go-service-s3:matrix.org.svg?logo=matrix)](https://matrix.to/#/#beyondstorage@go-service-s3:matrix.org)
  • Quick Start: How to init service/storager (via connection string)
  • Docs: The links to go-service-s3 docs page

Please leave a comment if you want to take a part!

Services

Here is the list of all our services repo. Services that are not stable don't need to apply this change.

@Xuanwo Xuanwo mentioned this issue Sep 6, 2021
6 tasks
@Xuanwo
Copy link
Contributor Author

Xuanwo commented Sep 8, 2021

I start a PR for it: beyondstorage/go-service-s3#208

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

No branches or pull requests

1 participant