github.com/mendersoftware/go-lib-micro@v0.0.0-20240304135804-e8e39c59b148/README.md (about)

     1  # go-lib-micro
     2  [![Build Status](https://gitlab.com/Northern.tech/Mender/go-lib-micro/badges/master/pipeline.svg)](https://gitlab.com/Northern.tech/Mender/go-lib-micro/pipelines)
     3  [![Coverage Status](https://coveralls.io/repos/github/mendersoftware/go-lib-micro/badge.svg?branch=master)](https://coveralls.io/github/mendersoftware/go-lib-micro?branch=master)
     4  [![Go Report Card](https://goreportcard.com/badge/github.com/mendersoftware/go-lib-micro)](https://goreportcard.com/report/github.com/mendersoftware/go-lib-micro)
     5  
     6  
     7  Mender: go-lib-micro
     8  ==============================================
     9  
    10  Mender is an open source over-the-air (OTA) software updater for embedded Linux
    11  devices. Mender comprises a client running at the embedded device, as well as
    12  a server that manages deployments across many devices.
    13  
    14  This repository contains the Mender go-lib-micro library, which is part of the
    15  Mender server. The Mender server is designed as a microservices architecture
    16  and comprises several repositories.
    17  
    18  The go-lib-micro library is a collection of utilities and middlewares shared among microservices in the Mender ecosystem.
    19  
    20  
    21  ![Mender logo](https://mender.io/user/pages/04.resources/_logos/logoS.png)
    22  
    23  
    24  ## Getting started
    25  
    26  To start using Mender, we recommend that you begin with the Getting started
    27  section in [the Mender documentation](https://docs.mender.io/).
    28  
    29  ## Using the library
    30  
    31  The library's code is divided into subpackages, which can be imported the standard Go way:
    32  
    33  ```
    34  import (
    35      "github.com/mendersoftware/go-lib-micro/log"
    36      "github.com/mendersoftware/go-lib-micro/requestid"
    37  )
    38  ```
    39  
    40  For example usage, please see e.g. the [Mender Deployments Service](https://github.com/mendersoftware/deployments).
    41  
    42  
    43  ## Contributing
    44  
    45  We welcome and ask for your contribution. If you would like to contribute to Mender, please read our guide on how to best get started [contributing code or
    46  documentation](https://github.com/mendersoftware/mender/blob/master/CONTRIBUTING.md).
    47  
    48  ## License
    49  
    50  Mender is licensed under the Apache License, Version 2.0. See
    51  [LICENSE](https://github.com/mendersoftware/go-lib-micro/blob/master/LICENSE) for the
    52  full license text.
    53  
    54  ## Security disclosure
    55  
    56  We take security very seriously. If you come across any issue regarding
    57  security, please disclose the information by sending an email to
    58  [security@mender.io](security@mender.io). Please do not create a new public
    59  issue. We thank you in advance for your cooperation.
    60  
    61  ## Connect with us
    62  
    63  * Join the [Mender Hub discussion forum](https://hub.mender.io)
    64  * Follow us on [Twitter](https://twitter.com/mender_io). Please
    65    feel free to tweet us questions.
    66  * Fork us on [Github](https://github.com/mendersoftware)
    67  * Create an issue in the [bugtracker](https://northerntech.atlassian.net/projects/MEN)
    68  * Email us at [contact@mender.io](mailto:contact@mender.io)
    69  * Connect to the [#mender IRC channel on Libera](https://web.libera.chat/?#mender)