Skip to content

Commit

Permalink
feat: Create README
Browse files Browse the repository at this point in the history
  • Loading branch information
sxt-devops committed Nov 7, 2024
1 parent 70b75e6 commit fcdef30
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
# sxt-node-docs
# Sxt Node Docs

docs for sxt-node

## πŸ“‘ Table of Contents

- [πŸ› οΈ Installation](#installation)
- [πŸš€ Usage](#usage)
- [🀝 Contributing](#contributing)
- [πŸ“ Commit Messages](#commit-messages)
- [πŸ“§ Contact](#contact)
- [πŸ“š Additional Resources](#additional-resources)

## <a name="installation"></a>πŸ› οΈ Installation

Provide instructions on how to install or set up the project. Include any dependencies that need to be installed and how to install them.

## <a name="usage"></a>πŸš€ Usage

Explain how to use the project. Provide examples if applicable. This could include command line instructions, code snippets, or screenshots.

## <a name="contributing"></a>🀝 Contributing

If you would like others to contribute to your project, provide guidelines for how they can do so. This could include information on how to report bugs, suggest enhancements, or submit pull requests.

#### <a name="commit-messages"></a>πŸ“ Commit Messages

Please ensure your commits follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) standards. Doing so allows our CI system to properly categorize changes during the release process.

## <a name="contact"></a>πŸ“§ Contact

For questions on this repository, please reach out to [dalbertom](https://github.com/dalbertom).

## <a name="additional-resources"></a>πŸ“š Additional Resources

- [πŸ“‹ Changelog](CHANGELOG.md)
- [πŸ“œ License](LICENSE)
- [πŸ‘¨β€πŸ’» Code Owners](CODEOWNERS)

0 comments on commit fcdef30

Please sign in to comment.