Skip to content

Commit ed0390e

Browse files
committed
readme updates
1 parent 4d96b20 commit ed0390e

File tree

1 file changed

+31
-55
lines changed

1 file changed

+31
-55
lines changed

README.md

Lines changed: 31 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,55 @@
11
# Vanguard Documentation
22

3-
Welcome to the official documentation for Vanguard, an open-source Laravel application for managing remote server backups.
3+
Documentation for Vanguard, an open-source Laravel application for managing remote server backups.
44

5-
## About Vanguard
5+
## About
66

7-
Vanguard is a powerful tool that allows users to:
8-
1. Connect to remote Linux servers
9-
2. Facilitate backups from these servers to various destinations (e.g., S3 buckets)
10-
3. Enable both scheduled and manual backup operations
7+
Vanguard enables users to connect to remote Linux servers, create backups to various destinations (S3, etc.), and run scheduled or manual backup operations.
118

12-
## Documentation Platform
9+
## Development
1310

14-
Our documentation is powered by [VitePress](https://vitepress.dev/), a static site generator designed for building fast, content-focused websites.
15-
16-
## Getting Started
11+
This documentation uses [VitePress](https://vitepress.dev/).
1712

1813
### Prerequisites
1914

20-
- Node.js (version 18 or higher)
15+
- Node.js (v20+)
2116
- npm or yarn
2217

23-
### Installation
24-
25-
1. Clone the repository:
26-
```
27-
git clone https://github.com/vanguardbackup/docs.git
28-
cd docs
29-
```
30-
31-
2. Install dependencies:
32-
```
33-
npm install
34-
# or
35-
yarn install
36-
```
37-
38-
3. Start the development server:
39-
```
40-
npm run docs:dev
41-
# or
42-
yarn docs:dev
43-
```
44-
45-
4. Build for production:
46-
```
47-
npm run docs:build
48-
# or
49-
yarn docs:build
50-
```
51-
52-
## Documentation Structure
53-
54-
- `/docs`: Contains all markdown files for the documentation
55-
- `/docs/.vitepress`: VitePress configuration and theme customization
56-
- `/public`: Static assets like images and icons
18+
### Quick Start
5719

58-
## Contributing
20+
```bash
21+
# Install dependencies
22+
npm install
23+
24+
# Development server
25+
npm run docs:dev
26+
27+
# Build for production
28+
npm run docs:build
29+
```
5930

60-
We welcome contributions to improve Vanguard's documentation! If you notice any mistakes, areas for improvement, or want to add new content:
31+
## Structure
6132

33+
- `/`: Documentation markdown files
34+
- `/.vitepress`: Configuration and theme
35+
- `/api`: API markdown files
36+
- `/public`: Static assets
37+
38+
## Contributing
39+
40+
To contribute:
6241
1. Fork the repository
63-
2. Create a new branch for your changes
64-
3. Make your improvements
65-
4. Submit a pull request with a clear description of your changes
42+
2. Create a branch for your changes
43+
3. Submit a pull request
6644

6745
## License
6846

69-
Vanguard's documentation is licensed under the MIT Licence. See the [LICENSE](LICENSE) file for more details.
47+
MIT License. See the [LICENSE](LICENSE) file.
7048

7149
## Security
7250

73-
If you discover a security vulnerability within the documentation or the Vanguard application itself, please follow our [security policy](https://github.com/vanguardbackup/vanguard/blob/main/SECURITY.md). Do not disclose security-related issues publicly until they have been addressed by the Vanguard team.
51+
Please report security vulnerabilities according to our [security policy](https://github.com/vanguardbackup/vanguard/blob/main/SECURITY.md).
7452

7553
## Support
7654

77-
For questions, suggestions, or help with the documentation please open an issue in this repository.
78-
79-
Thank you for contributing to Vanguard's documentation.
55+
For questions or suggestions, please open an issue in this repository.

0 commit comments

Comments
 (0)