Skip to main content

[App / Add-On Name]

Description of the project: self-explanatory, clearly state the scope. Provide technical insights by referencing specific environments, frameworks, tools, libraries used (incl. versions).

Features (optional)​

What makes your project stand out? Highlight relevant features.

Getting Started​

[Quick description of what the app does]

Requirements (optional)​

What things you need to have installed to run installation smoothly. Add also details on how to install them.

Installation​

Tell other users how to install your project. Optionally, include a gif to make the process even more clear for other people. Add links to Splunk documentation for details instructions on cloud / on-prem. Specify on which tier the app / add-on must be installed (e.g. Search Head, Heavy Forwarder, etc.)

Configuration (optional)​

Explain how to configure your project after installation.

Usage​

Instruct other people on how to use your project after they’ve installed it. This would also be a good place to include screen shots of your project in action.

Troubleshooting​

Give some hints on how to troubleshoot your app/add-on. Add troubleshooting steps and resources.

Example(s) (optional)​

Add here examples of usages. Another good place to include screenshots or gifs.

Tests (optional)​

Explain how to run tests if you've provided some.

Versions Supported​

[List tested and supported versions]

Credits & Acknowledgements (optional)​

  • [Contributor 1]
  • [Contributor 2]
  • [Contributor 3]

References (optional)​

Provide any relevant link to the app / add-on / project.

Contributing​

See the CONTRIBUTING.md file for details.