mirror of
https://github.com/LightZirconite/Microsoft-Rewards-Bot.git
synced 2026-01-10 17:26:17 +00:00
Add comprehensive FAQ and README documentation for Microsoft Rewards Script
- Created FAQ.md with detailed answers to common questions regarding the project, installation, configuration, troubleshooting, safety, and features. - Established README.md to serve as a documentation hub, outlining the structure and providing quick navigation links to various guides and resources.
This commit is contained in:
82
assets/README.md
Normal file
82
assets/README.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# 🎨 Assets Directory
|
||||
|
||||
This folder contains visual assets for the Microsoft Rewards Script project.
|
||||
|
||||
## 📁 Contents
|
||||
|
||||
### `logo.png`
|
||||
**The official project mascot and logo**
|
||||
|
||||
- **Dimensions:** Original size preserved
|
||||
- **Format:** PNG with transparency
|
||||
- **Usage:**
|
||||
- README.md header (200px width)
|
||||
- Documentation pages (120-150px width)
|
||||
- Social media and promotional materials
|
||||
|
||||
## 📐 Logo Usage Guidelines
|
||||
|
||||
### Recommended Sizes
|
||||
|
||||
| Context | Recommended Width | Example |
|
||||
|---------|------------------|---------|
|
||||
| Main README | 200px | `<img src="assets/logo.png" width="200"/>` |
|
||||
| Documentation pages | 120-150px | `<img src="../assets/logo.png" width="120"/>` |
|
||||
| GitHub social preview | 1200x630px | Resize as needed |
|
||||
| Favicon | 32x32px or 64x64px | Convert to ICO format |
|
||||
|
||||
### Usage Examples
|
||||
|
||||
**In README.md (root):**
|
||||
```markdown
|
||||
<div align="center">
|
||||
<img src="assets/logo.png" alt="Microsoft Rewards Script Logo" width="200"/>
|
||||
</div>
|
||||
```
|
||||
|
||||
**In docs/*.md files:**
|
||||
```markdown
|
||||
<div align="center">
|
||||
<img src="../assets/logo.png" alt="Microsoft Rewards Script Logo" width="120"/>
|
||||
</div>
|
||||
```
|
||||
|
||||
**In HTML:**
|
||||
```html
|
||||
<img src="assets/logo.png" alt="Microsoft Rewards Script Logo" style="width: 200px; display: block; margin: 0 auto;">
|
||||
```
|
||||
|
||||
## 🎨 Design Notes
|
||||
|
||||
The logo represents the project's mascot and serves as the visual identity for:
|
||||
- Documentation headers
|
||||
- Community presence (Discord, etc.)
|
||||
- Project branding
|
||||
- Social media
|
||||
|
||||
## 📝 Attribution
|
||||
|
||||
Logo created for the Microsoft Rewards Script project.
|
||||
|
||||
## 🔒 Usage Rights
|
||||
|
||||
This logo is part of the Microsoft Rewards Script project and follows the same [LICENSE](../LICENSE) as the project code.
|
||||
|
||||
---
|
||||
|
||||
## 🖼️ Future Assets
|
||||
|
||||
This directory may be expanded to include:
|
||||
- Screenshots for documentation
|
||||
- Diagrams and flowcharts
|
||||
- Favicon files
|
||||
- Social media banners
|
||||
- Tutorial images
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
**[← Back to README](../README.md)**
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user