-
Notifications
You must be signed in to change notification settings - Fork 226
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add readme to the new yadm file
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Yadm | ||
|
||
Yadm is a dot files manager that is written in Bash. | ||
The code in this module reflects this fact. | ||
The functions in this repo are typed wrappers around yadm. | ||
|
||
## Usage | ||
|
||
To use this module make sure you have installed yadm. | ||
|
||
Then copy this folder to the folder where you place your nu scripts | ||
Which is usually in `$"($nu.default-config-dir)"/scripts`. | ||
|
||
Then reference the folder by doing in the scripts/mod.nu file. | ||
|
||
```nu | ||
export module yadm | ||
``` | ||
|
||
## Contributing | ||
|
||
This module doesn't represent all of git's functionality. | ||
Which means it doesn't allow you to do everything git can. | ||
if there is something missing please submit a PR to this repo. | ||
If you can help please checkout git completions for a reference. |