About

[?] Provide general information about your project here. What problem does it (intend to) solve? What is the purpose of your project? Why did you undertake it? You don't have to answer all the questions -- just the ones relevant to your project. Screenshots [?] Please provide your screenshots here. Home Page Login Page

Built With

• Rust

[?] Please provide the technologies that are used in the project.

Getting Started

Prerequisites

• Rust

[?] What are the project requirements/dependencies?

Installation

GitHub analytics

curl -sL https://raw.githubusercontent.com/keep-starknet-strange/heimdall/main/heimdall-rs/installers/githup | sh

Usage

CLI

cargo run -- --dir-path ./ comments check-comments

github-analytics 7 --print

Infra

See infra readme here

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

[?] Provide additional ways to contact the project maintainer/maintainers.

Reach out to the maintainer at one of the following places:

• GitHub Discussions
• Contact options listed on this GitHub profile

Project assistance

If you want to say thank you or/and support active development of Heimdall:

• Add a GitHub Star to the project.
• Tweet about the Heimdall.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make Heimdall better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Lucas Levy <@LucasLvy>.

For a full list of all authors and contributors, see the contributors page.

Security

Heimdall follows good practices of security, but 100% security cannot be assured. Heimdall is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements

[?] If your work was funded by any organization or institution, acknowledge their support here. In addition, if your work relies on other software libraries, or was inspired by looking at other work, it is appropriate to acknowledge this intellectual debt too.