8000 docs: update README by sasa-tomic · Pull Request #1267 · dfinity/dre · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: update README #1267

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

Jump to bottom
Merged
merged 1 commit into from
Feb 4, 2025
Merged

docs: update README #1267

merged 1 commit into from
Feb 4, 2025

Conversation

sasa-tomic
Copy link
Member

README Enhancements

  • Added Badges: Introduced shields for license, Rust, Python, and Bazel.

  • Expanded Content:

    • Provided a brief project description.
    • Introduced a clear and structured Table of Contents.

  • Sections Added:

    • Documentation: Linked to detailed API references, usage examples, and troubleshooting guides.
    • Features:
      • Described core components including DRE CLI Tool and Dashboard.
      • Elaborated on monitoring, logging, and infrastructure management features.
    • Installation: Offered step-by-step installation instructions.
    • Usage: Added CLI command examples and authentication options.
    • Contributing: Included guidelines for contributing to the project.
    • License: Provided a clear licensing statement.

  • Visual Separation: Used emojis for section headings for better visual clarity.

  • Grammar and Style: Enhanced readability and consistency.

@sasa-tomic
docs: expand README with detailed sections and badges
0623838 
### Summary
Enhances the `README.md` to improve clarity and provide comprehensive information about the DRE project.

### Changes
- **Badges Added**: Display project license and compatibility with Rust, Python, and Bazel.
- **Expanded Sections**:
  - **Documentation**: Direct links to detailed, searchable online documentation including API references and troubleshooting guides.
  - **Features**: Detailed breakdown of core components, monitoring, logging, and infrastructure management tools.
  - **Installation**: Step-by-step installation guide with prerequisites.
  - **Usage**: Command overview and usage examples for the DRE CLI tool.
  - **Authentication Options**: Lists command-line options for enhanced security and network specification.
  - **Contributing**: Guidelines for potential contributors on code style and contribution process.
- **Interactive Elements**: Added table of contents for easy navigation.

### Documentation Links
- Updated references to guide users towards comprehensive online resources.

---
Built with ❤️ by the DFINITY Foundation
@sasa-tomic sasa-tomic requested a review from a team as a code owner February 4, 2025 17:46
@sasa-tomic sasa-tomic self-assigned this Feb 4, 2025
@sasa-tomic sasa-tomic changed the title docs: update README with comprehensive details docs: update README Feb 4, 2025
@sasa-tomic sasa-tomic merged commit 783821a into main Feb 4, 2025
5 checks passed
@sasa-tomic sasa-tomic deleted the enhance-readme-doc branch February 4, 2025 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NikolaMilosa NikolaMilosa NikolaMilosa approved these changes

Assignees

@sasa-tomic sasa-tomic

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sasa-tomic @NikolaMilosa
0