From 3a4f383a77d0147d8cfd096fa38d6fefa237b1d0 Mon Sep 17 00:00:00 2001 From: Lenny Goodell Date: Tue, 30 May 2023 17:21:11 -0700 Subject: [PATCH] docs: Add main branch warning (#314) Signed-off-by: Leonard Goodell --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 4918db51..babc57d1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # edgexfoundry/device-snmp-go [![Build Status](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/device-snmp-go/job/main/badge/icon)](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/device-snmp-go/job/main/) [![Code Coverage](https://codecov.io/gh/edgexfoundry/device-snmp-go/branch/main/graph/badge.svg?token=cQs6ERHT74)](https://codecov.io/gh/edgexfoundry/device-snmp-go) [![Go Report Card](https://goreportcard.com/badge/github.com/edgexfoundry/device-snmp-go)](https://goreportcard.com/report/github.com/edgexfoundry/device-snmp-go) [![GitHub Latest Dev Tag)](https://img.shields.io/github/v/tag/edgexfoundry/device-snmp-go?include_prereleases&sort=semver&label=latest-dev)](https://github.com/edgexfoundry/device-snmp-go/tags) ![GitHub Latest Stable Tag)](https://img.shields.io/github/v/tag/edgexfoundry/device-snmp-go?sort=semver&label=latest-stable) [![GitHub License](https://img.shields.io/github/license/edgexfoundry/device-snmp-go)](https://choosealicense.com/licenses/apache-2.0/) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/edgexfoundry/device-snmp-go) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr-raw/edgexfoundry/device-snmp-go)](https://github.com/edgexfoundry/device-snmp-go/pulls) [![GitHub Contributors](https://img.shields.io/github/contributors/edgexfoundry/device-snmp-go)](https://github.com/edgexfoundry/device-snmp-go/contributors) [![GitHub Committers](https://img.shields.io/badge/team-committers-green)](https://github.com/orgs/edgexfoundry/teams/device-snmp-go-committers/members) [![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/edgexfoundry/device-snmp-go)](https://github.com/edgexfoundry/device-snmp-go/commits) +> **Warning** +> The **main** branch of this repository contains work-in-progress development code for the upcoming release, and is **not guaranteed to be stable or working**. +> It is only compatible with the [main branch of edgex-compose](https://github.com/edgexfoundry/edgex-compose) which uses the Docker images built from the **main** branch of this repo and other repos. +> +> **The source for the latest release can be found at [Releases](https://github.com/edgexfoundry/device-snmp-go/releases).** #### Overview: A generic SNMP device service. Included is a sample for a network switch device driver. Additionally, a Patlite profile is included in the profiles director.