Skip to content

Commit

Permalink
doc(README): Update README.md
Browse files Browse the repository at this point in the history
There have been a warning about a malware which was detected by a cooperate Virus Scanner. So I added some details about this project being my private pet project and that it not officially related to ifm.
  • Loading branch information
graugans authored Mar 25, 2024
1 parent 28eca1a commit 742dad6
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@

# Go client for the ifm OVP8xx series of devices

⚠️ This is my personal project it is not an official ifm product. Please use the official [ifm3d](https://github.com/ifm/ifm3d) project if you need an officially supported version ⚠️

## Introduction

A GO module and cli to access the ifm OVP8xx series of devices.


[![GitHub go.mod Go version of a Go module](https://img.shields.io/github/go-mod/go-version/gomods/athens.svg)](https://github.com/gomods/athens)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![example workflow](https://github.com/graugans/go-ovp8xx/actions/workflows/go.yml/badge.svg)
Expand All @@ -19,6 +24,7 @@ This project is still a work in progress and will suffer from breaking API chang

The recommended and easiest way is to download the pre-build binary from the [GitHub Release page](https://github.com/graugans/go-ovp8xx/releases).

⚠️ The Windows binary maybe flagged by a Virus Scanner, please also read the note from the [Go Team](https://go.dev/doc/faq#virus) ⚠️

### Go get

Expand Down Expand Up @@ -81,4 +87,4 @@ Please ensure you have the Git Large File Storage extension installed. Some of t
```sh
git lfs fetch --all
git lfs pull
```
```

0 comments on commit 742dad6

Please sign in to comment.