Skip to content

Commit bc4d140

Browse files
author
woterr
committed
Readme update
1 parent 62fa7d8 commit bc4d140

2 files changed

Lines changed: 58 additions & 3 deletions

File tree

PKGBUILD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ url="https://github.com/woterr/dotpush"
99
license=('MIT')
1010
depends=('python' 'python-keyring' 'python-requests' 'python-installer')
1111
makedepends=('python-build' 'python-wheel' 'python-setuptools')
12-
source=(source=("$pkgname-$pkgver.tar.gz::https://github.com/woterr/dotpush/archive/refs/tags/v$pkgver.tar.gz"))
12+
source=("$pkgname-$pkgver.tar.gz::https://github.com/woterr/dotpush/releases/download/v$pkgver/dotpush-$pkgver.tar.gz")
1313
sha256sums=('0d532d61d75954f222258b0a6abc474e309458c8ccba62557a217a606af25316')
1414
install='dotpush.install'
1515

README.md

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ A lightweight tool that helps backup dotfiles and automatically push to a remote
66

77
[![Run Tests](https://github.com/woterr/dotpush/actions/workflows/tests.yml/badge.svg)](https://github.com/woterr/dotpush/actions/workflows/tests.yml) [![Run Linter and Formatter](https://github.com/woterr/dotpush/actions/workflows/ci.yml/badge.svg)](https://github.com/woterr/dotpush/actions/workflows/ci.yml)
88

9+
![License](https://img.shields.io/github/license/woterr/dotpush)
10+
911
## Features
1012
- Backs up dotfiles and configuration directories.
1113
- Secure GitHub push with token management.
@@ -16,7 +18,60 @@ A lightweight tool that helps backup dotfiles and automatically push to a remote
1618

1719
**Manual Installation**:
1820

19-
1. Get the latest release from [Releases](https://github.com/woterr/mydot/releases).
20-
2. Open the directory where the release was downloaded and build the package:
21+
1. Clone the repository.
22+
```bash
23+
git clone https://github.com/woterr/dotpush.git
24+
cd dotpush
25+
```
26+
27+
2. Build the package:
28+
```bash
29+
makepkg -si
30+
```
31+
32+
- `makepkg` reads your PKGBUILD, fetches the release tarball (from GitHub), checks SHA256, builds the wheel, installs everything including systemd service/timer files.
33+
- `-s` ensures dependencies are installed.
34+
- `-i` installs the package after building.
35+
36+
3. Verify installation:
37+
```bash
38+
dotpush --help
2139
```
40+
41+
## Usage
42+
43+
1. Initialize DotPush.
44+
45+
```bash
46+
dotpush init
47+
```
48+
(Run `dotpush init github` for GitHub integration)
49+
50+
2. Check `config.ini` and add paths as per requirement.
51+
52+
```bash
53+
nano ~/.config/dotpush/config.ini
2254
```
55+
56+
3. Backup your DotFiles.
57+
58+
```bash
59+
dotpush backup
60+
```
61+
62+
4. Manually push your DotFiles.
63+
64+
```bash
65+
dotpush push
66+
```
67+
68+
> [!NOTE]
69+
> The automated `dotpush backup` and `dotpush push` can be enabled by running dotpush backup and push.
70+
71+
## Contributing
72+
73+
Feel free to open issues or PRs. If you're unsure, just fork and experiment.
74+
75+
## License
76+
77+
This project is licensed under the MIT License. Read [LICENSE](LICENSE) for full license text.

0 commit comments

Comments
 (0)