Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
sdewitt-newrelic committed Apr 29, 2023
1 parent 22a65cf commit 62911b3
Showing 1 changed file with 63 additions and 1 deletion.
64 changes: 63 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,63 @@
# nr-entity-cmdb-sync
# New Relic Entity <> CMDB Sync Utility

[![New Relic Community header](https://opensource.newrelic.com/static/Community_Project-0c3079a4e4dbe2cbd05edc4f8e169d7b.png)](https://opensource.newrelic.com/oss-category/#new-relic-community)

![GitHub forks](https://img.shields.io/github/forks/newrelic/nr-entity-cmdb-sync?style=social)
![GitHub stars](https://img.shields.io/github/stars/newrelic/nr-entity-cmdb-sync?style=social)
![GitHub watchers](https://img.shields.io/github/watchers/newrelic/nr-entity-cmdb-sync?style=social)

![GitHub all releases](https://img.shields.io/github/downloads/newrelic/nr-entity-cmdb-sync/total)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/newrelic/nr-entity-cmdb-sync)
![GitHub last commit](https://img.shields.io/github/last-commit/newrelic/nr-entity-cmdb-sync)
![GitHub Release Date](https://img.shields.io/github/release-date/newrelic/nr-entity-cmdb-sync)

![GitHub issues](https://img.shields.io/github/issues/newrelic/nr-entity-cmdb-sync)
![GitHub issues closed](https://img.shields.io/github/issues-closed/newrelic/nr-entity-cmdb-sync)
![GitHub pull requests](https://img.shields.io/github/issues-pr/newrelic/nr-entity-cmdb-sync)
![GitHub pull requests closed](https://img.shields.io/github/issues-pr-closed/newrelic/nr-entity-cmdb-sync)

## Installation

> [Include a step-by-step procedure on how to get your code installed. Be sure to include any third-party dependencies that need to be installed separately]
## Getting Started

>[Simple steps to start working with the software similar to a "Hello World"]
## Usage

>[**Optional** - Include more thorough instructions on how to use the software. This section might not be needed if the Getting Started section is enough. Remove this section if it's not needed.]
## Building

>[**Optional** - Include this section if users will need to follow specific instructions to build the software from source. Be sure to include any third party build dependencies that need to be installed separately. Remove this section if it's not needed.]
## Testing

>[**Optional** - Include instructions on how to run tests if we include tests with the codebase. Remove this section if it's not needed.]
## Support

New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:

>Add the url for the support thread here: discuss.newrelic.com
## Contribute

We encourage your contributions to improve [project name]! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.

If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.

**A note about vulnerabilities**

As noted in our [security policy](../../security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic).

If you would like to contribute to this project, review [these guidelines](./CONTRIBUTING.md).

To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to [Project Name](<LINK TO https://opensource.newrelic.com/projects/... PAGE>).

## License
[Project Name] is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.
>[If applicable: The [project name] also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.]

0 comments on commit 62911b3

Please sign in to comment.