Skip to content

Commit e2ba65f

Browse files
minor README changes, updated gitignore and credentials
1 parent 8a4b1fa commit e2ba65f

File tree

3 files changed

+23
-34
lines changed

3 files changed

+23
-34
lines changed

.gitignore

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
#
2-
# Don't commit…
2+
# Ignore
33
#
44

5-
# Custom files
6-
assets/
7-
8-
# temp files
95
*.swp
106
.DS_Store

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2021 Nicolò Diamante <hello@nicolodiamante.com>
3+
&#169; 2023 Nicolò Diamante <hello@nicolodiamante.com>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

README.md

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
1-
<p align="center"><a href="#"><img src="https://user-images.githubusercontent.com/48920263/110962274-1605ca80-8351-11eb-8e71-c3b43d6e48fd.png" draggable="false" ondragstart="return false;" alt="iCloud NoSync Title" title="iCloud NoSync" /></a></p>
1+
<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/icloud-nosync/assets/48920263/eaf1d930-22b8-4c3f-bd9c-cc2209a1412a" draggable="false" ondragstart="return false;" alt="iCloud NoSync Title" title="iCloud NoSync" /></a></p>
22

3-
[iCloud][apple-icloud] runs constantly in the background, syncing files across
4-
devices. This utility helps you prevent this. So, how to interrupt iCloud from
5-
syncing files or folders? It turns out that Apple maintains a blacklist of file
6-
names and extensions that users should avoid using in their iCloud Drive. Adding
7-
the extension `.nosync` to a file prevents iCloud from syncing that file making
8-
it ineligible, which could be quite useful as a method of selective syncing.
9-
You could use the same extension in a folder, but it would not stop iCloud from
10-
sync its content, only folders that are named `tmp` or ending with `.tmp` will
11-
not synchronize, nor their contents.
3+
[iCloud][apple-icloud] is a powerful utility that allows users to sync files across multiple devices. However, sometimes users may want to prevent certain files or folders from syncing. Apple has a blacklist of file names and extensions that users should avoid using in their iCloud Drive. Adding the extension .nosync to a file is a simple way to prevent iCloud from syncing that file. This technique is useful for selective syncing. However, adding the same extension to a folder will not prevent iCloud from syncing its contents. The only way to prevent an entire folder from syncing is to name it tmp or end it with .tmp.
4+
<br/><br/><br/><br/>
125

13-
<p align="center"><a href="#"><img src="https://user-images.githubusercontent.com/48920263/110946875-b9e67a80-833f-11eb-806b-5252af874b8e.png" draggable="false" ondragstart="return false;" alt="iCloud Sync Status" title="iCloud Sync Status" width="590px" /></a></p>
6+
<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/icloud-nosync/assets/48920263/02e60447-aa41-4c2f-87fb-eda75b10d4cd" draggable="false" ondragstart="return false;" alt="iCloud Sync Status" title="iCloud Sync Status" width="650px" /></a></p>
147

15-
**iCloud No Sync:** hides and appends the appropriate extension, depending on
16-
whether it is a file or folder, to stop the sync, then creates a symbolic
17-
link with the same name of the original one to avoid any problems that might
18-
occur with applications that depend on it.
8+
<br/><br/><br/>
199

20-
**iCloud Sync:** unhides the original file or folder, then it removes the
21-
symbolic link and the extension to restart the synchronization (always
22-
refer to the symlink to restart the sync).<br/><br/>
10+
**iCloud No Sync:** hides and appends the appropriate extension to the file or folder, effectively stopping the sync process. It then creates a symbolic link with the same name as the original file or folder to avoid any issues with applications that depend on it.
11+
12+
<br/>
13+
14+
**iCloud Sync:** it first unhides the original file or folder. Then, it removes the symbolic link and the extension to restart the synchronization. This means that iCloud Sync always refers to the symlink to restart the sync, which ensures that the latest version of the file or folder is synchronized across all your devices. By removing the symbolic link and the extension, iCloud Sync ensures that the sync is done from scratch, which reduces the chances of any errors or conflicts during the synchronization process.<br/><br/>
2315

2416
## Getting Started
2517

@@ -31,23 +23,25 @@ Download the repository via curl:
3123
sh -c "$(curl -fsSL https://raw.githubusercontent.com/nicolodiamante/icloud-nosync/HEAD/bootstrap.sh)"
3224
```
3325

34-
Alternatively, clone manually:
26+
Alternatively, you can clone the repository manually:
3527

3628
```shell
3729
git clone https://github.com/nicolodiamante/icloud-nosync.git
3830
```
3931

40-
Head over into the repository, then:
32+
Once you have downloaded the repository, you can navigate into its directory in the terminal and paste the following code:
4133

4234
```shell
4335
cd utils && source install.sh
4436
```
4537

46-
> The script will make a copy of the workflow files into `~/Library/Services`.
38+
The script will make a copy of the workflow files into `~/Library/Services`.
39+
40+
<br/>
4741

4842
### Show in Quick Action Menu
4943

50-
Open System Preferences <a href="#"><img src="https://user-images.githubusercontent.com/48920263/113451325-0df5f380-9402-11eb-80ea-cf4140340ab4.png" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /></a> Extensions <a href="#"><img src="https://user-images.githubusercontent.com/48920263/113451325-0df5f380-9402-11eb-80ea-cf4140340ab4.png" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /></a> Select Finder then check the box:
44+
Open System Preferences <a href="#"><img src="https://github.com/nicolodiamante/icloud-nosync/assets/48920263/1905590e-328d-4f7b-9501-2371681a648a" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /></a> Extensions <a href="#"><img src="https://github.com/nicolodiamante/icloud-nosync/assets/48920263/1905590e-328d-4f7b-9501-2371681a648a" draggable="false" ondragstart="return false;" alt="Arrow" title="Arrow" width="5.4px" /></a> Select Finder then check the box:
5145

5246
- [x] iCloud No Sync
5347
- [x] iCloud Sync
@@ -57,8 +51,8 @@ Open System Preferences <a href="#"><img src="https://user-images.githubusercont
5751
1. Right-click to the file or folder you want to stop syncing to iCloud Drive.
5852
2. Select `iCloud No Sync` from the `Quick Actions` menu to stop the sync.
5953
3. Select `iCloud Sync` from the `Quick Actions` menu to sync it again.
60-
61-
<p align="center"><a href="#"><img src="https://user-images.githubusercontent.com/48920263/110946959-d5518580-833f-11eb-9eca-f7f8134e2cc9.png" draggable="false" ondragstart="return false;" alt="Quick Actions Menu" title="Quick Actions Menu" width="700px" /></a></p>
54+
<br/><br/><br/><br/>
55+
<p align="center"><a href="#"><img src="https://github.com/nicolodiamante/icloud-nosync/assets/48920263/bb66901a-2622-4a05-bdb7-34801e4ecf1e" draggable="false" ondragstart="return false;" alt="Quick Actions Menu" title="Quick Actions Menu" width="560px" /></a></p><br/><br/>
6256

6357
## Notes
6458
### Resources
@@ -67,14 +61,13 @@ Open System Preferences <a href="#"><img src="https://user-images.githubusercont
6761

6862
### Contribution
6963

70-
Please report any issues or bugs to the [issues page][issues]. Suggestions for
71-
improvements are welcome!<br/><br/>
64+
Any suggestions or feedback you may have for improvement are welcome. If you encounter any issues or bugs, please report them to the [issues page][issues].<br/><br/>
7265

7366
<p align="center"><a href="#"><img src="https://user-images.githubusercontent.com/48920263/113406768-5a164900-93ac-11eb-94a7-09377a52bf53.png" draggable="false" ondragstart="return false;" /></a></p>
7467

75-
<p align="center"><a href="https://nicolodiamante.com" target="_blank"><img src="https://user-images.githubusercontent.com/48920263/113433823-31a84200-93e0-11eb-9ffb-9111b389ef2f.png" draggable="false" ondragstart="return false;" alt="Nicol&#242; Diamante Portfolio" title="Nicol&#242; Diamante" width="11px" /></a></p>
68+
<p align="center"><a href="https://nicolodiamante.com" target="_blank"><img src="https://github.com/nicolodiamante/icloud-nosync/assets/48920263/12de7670-404a-43f8-8997-70361174c30e" draggable="false" ondragstart="return false;" alt="Nicol&#242; Diamante Portfolio" title="Nicol&#242; Diamante" width="11px" /></a></p>
7669

77-
<p align="center"><a href="https://github.com/nicolodiamante/icloud-nosync/blob/main/LICENSE.md" target="_blank"><img src="https://user-images.githubusercontent.com/48920263/110947109-06ca5100-8340-11eb-99cf-8d245044b8a3.png" draggable="false" ondragstart="return false;" alt="The MIT License" title="The MIT License (MIT)" width="90px" /></a></p>
70+
<p align="center"><a href="https://github.com/nicolodiamante/icloud-nosync/blob/main/LICENSE.md" target="_blank"><img src="https://github.com/nicolodiamante/icloud-nosync/assets/48920263/957a61a7-8aba-4907-b099-97fec8bfb99a" draggable="false" ondragstart="return false;" alt="The MIT License" title="The MIT License (MIT)" width="90px" /></a></p>
7871

7972
<!-- Link labels: -->
8073
[apple-icloud]: https://www.apple.com/icloud/

0 commit comments

Comments
 (0)