Skip to content

docs: [SDK] Update README for new doc structure #1504

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.

Sign up for GitHub

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

Merged
lenny-goodell merged 1 commit into from
Oct 31, 2023
Merged

docs: [SDK] Update README for new doc structure #1504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@
# Application Functions SDK
[![Build Status](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/app-functions-sdk-go/job/main/badge/icon)](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/app-functions-sdk-go/job/main/) [![Code Coverage](https://codecov.io/gh/edgexfoundry/app-functions-sdk-go/branch/main/graph/badge.svg?token=E4uzIvukPu)](https://codecov.io/gh/edgexfoundry/app-functions-sdk-go) [![Go Report Card](https://goreportcard.com/badge/github.com/edgexfoundry/app-functions-sdk-go)](https://goreportcard.com/report/github.com/edgexfoundry/app-functions-sdk-go) [![GitHub Latest Dev Tag)](https://img.shields.io/github/v/tag/edgexfoundry/app-functions-sdk-go?include_prereleases&sort=semver&label=latest-dev)](https://github.com/edgexfoundry/app-functions-sdk-go/tags) ![GitHub Latest Stable Tag)](https://img.shields.io/github/v/tag/edgexfoundry/app-functions-sdk-go?sort=semver&label=latest-stable) [![GitHub License](https://img.shields.io/github/license/edgexfoundry/app-functions-sdk-go)](https://choosealicense.com/licenses/apache-2.0/) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/edgexfoundry/app-functions-sdk-go) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr-raw/edgexfoundry/app-functions-sdk-go)](https://github.com/edgexfoundry/app-functions-sdk-go/pulls) [![GitHub Contributors](https://img.shields.io/github/contributors/edgexfoundry/app-functions-sdk-go)](https://github.com/edgexfoundry/app-functions-sdk-go/contributors) [![GitHub Committers](https://img.shields.io/badge/team-committers-green)](https://github.com/orgs/edgexfoundry/teams/app-functions-sdk-go-committers/members) [![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/edgexfoundry/app-functions-sdk-go)](https://github.com/edgexfoundry/app-functions-sdk-go/commits) [![Go](https://github.com/edgexfoundry/app-functions-sdk-go/actions/workflows/go.yml/badge.svg)](https://github.com/edgexfoundry/app-functions-sdk-go/actions/workflows/go.yml)

Welcome the App Functions SDK for EdgeX. This sdk is meant to provide all the plumbing necessary for developers to get started in processing/transforming/exporting data out of EdgeX.
Welcome the App Functions SDK for EdgeX. This sdk is meant to provide all the plumbing necessary for developers to get started in processing/transforming/exporting data out of EdgeX.

For latest documentation please visit
- https://docs.edgexfoundry.org/latest/microservices/application/ApplicationServices/
- https://docs.edgexfoundry.org/latest/microservices/application/sdk/Purpose/

For documentation please visit https://docs.edgexfoundry.org/latest/microservices/application/ApplicationServices/.
For a list of examples please visit https://docs.edgexfoundry.org/latest/examples/AppServiceExamples/

## Build Prerequisites

Please see the [edgex-go README](https://github.com/edgexfoundry/edgex-go/blob/master/README.md).
Please see the [edgex-go README](https://github.com/edgexfoundry/edgex-go/blob/master/README.md#prerequisites).

## Versioning

Expand Down