Skip to content

Commit 5b1e93b

Browse files
committed
Update documentation
1 parent 8518f85 commit 5b1e93b

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

HotReloading.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ function stop_command {
3535
done
3636
}
3737

38+
# FSWatch is going to be responsible for detecting some events in the monitored repository
39+
# such as: Renamed, MovedTo, Removed, Updated, Updated.
40+
# Those events are the ones I thought would be enough. If I forgot any, please, consider to contribute.
41+
3842
# shellcheck disable=SC2162
3943
fswatch -0 "$MONITORED_FOLDER" --exclude "$EXCLUDED_FOLDERS_REGEX" --event Renamed --event MovedTo --event Removed --event Updated --event Created | while read -d "" _; do
4044
if [ -f "$BUILDING_FILE" ]; then

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Silicon is a Swift Package built upon the core technology of the [Silicon app](https://github.com/DigiDNA/Silicon), a product of [DigiDNA](https://www.digidna.net).
44

5-
> **Note:** This tool was originally designed to expose only an API using CLI to other apps via JSON format. However, due to my own interest in expanding it, I've decided to also play a bit more and create a TUI (_Terminal User Interface_) version of it. With that, now you can not only see the list of apps in Text and JSON mode but also make use of a full Terminal app with some features implemented. None of the original Silicon CLI is out; everything is in the same place as before, with just an addition.
5+
This tool was originally designed to expose only an API using CLI to other apps via JSON format. However, due to my own interest in expanding it, I've decided to also play a bit more and create a TUI (_Terminal User Interface_) version of it. With that, now you can also see the list of apps in Plain Text, JSON Format but also in a full Terminal app. The original library is still there to be used, just need to add this repo as dependency and import `SiliconLibrary`.
66

77
## CLI
88

@@ -74,6 +74,12 @@ Features implemented (so far):
7474
- [x] Filter by four categories (Silicon, Intel, System, and Electron)
7575
- [x] Details of the apps
7676

77+
To Do:
78+
- [ ] Search apps by text
79+
- [ ] Open an app
80+
- [ ] Uninstall an app
81+
- [ ] Create a target on Makefile to install `silicon` and `silicon-cli`
82+
7783
To use, just run in the root of the project
7884

7985
```shell
@@ -83,7 +89,8 @@ make run-app
8389

8490
## System Requirements
8591

86-
- Swift 5.9 or newer
92+
- Swift 5.9 or newer
93+
- [FSWatch](https://emcrisostomo.github.io/fswatch/)
8794

8895
## Compile and run
8996

@@ -92,11 +99,11 @@ $ git clone https://github.com/unnamedd/SiliconCLI.git
9299
$ cd SiliconCLI
93100
$ make run
94101
```
95-
It is provided some very useful targets in the Makefile, just run
102+
It is provided some very useful targets in the Makefile, just run
96103
```shell
97104
$ make
98105
# or
99-
$ make help
106+
$ make help
100107
```
101108

102109
![](docs/help.png)
@@ -112,5 +119,5 @@ Silicon CLI and TUI App was developed and is maintained by [Thiago Holanda](http
112119

113120
## License
114121

115-
Silicon CLI and TUI App is available under the [MIT License](http://opensource.org/licenses/MIT).
122+
Silicon CLI and TUI App is available under the [MIT License](http://opensource.org/licenses/MIT).
116123
You can find all the necessary details in the [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)