dorky 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,15 +4,19 @@ DevOps Records Keeper
|
|
|
4
4
|
## Steps to use:
|
|
5
5
|
|
|
6
6
|
> Setup AWS_ACCESS_KEY, AWS_SECRET_KEY, AWS_REGION before hand.
|
|
7
|
+
|
|
7
8
|
> Create a S3 bucket with the name `dorky` before start.
|
|
8
9
|
|
|
9
10
|
### To push files to S3 bucket.
|
|
10
|
-
1.
|
|
11
|
-
2.
|
|
12
|
-
3. List the files using `dorky list`, (make sure to add excluded file or folder patterns to .dorkyignore, to minimize the list).
|
|
11
|
+
1. Initialize dorky setup in the root folder of your project, using `dorky init`.
|
|
12
|
+
2. List the files using `dorky list`, (make sure to add excluded file or folder patterns to .dorkyignore, to minimize the list).
|
|
13
13
|
3. Add files to stage-1 using `dorky add file-name`.
|
|
14
14
|
4. Push files to S3 bucket using `dorky push`.
|
|
15
15
|
|
|
16
|
+
### To remove a file from project.
|
|
17
|
+
1. Remove files using `dorky reset file-name`.
|
|
18
|
+
2. Push files to S3 bucket using `dorky push`.
|
|
19
|
+
|
|
16
20
|
### To pull files from S3 bucket.
|
|
17
21
|
1. Initialize dorky project using `dorky init`.
|
|
18
22
|
2. Use `dorky pull` to pull the files from S3 bucket.
|