Skip to content

Improved README file #1274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improved README file #1274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,50 @@
Watchman exists to watch files and record when they actually change. It can
also trigger actions (such as rebuilding assets) when matching files change.

## Installation Instructions

macOS (via Homebrew)
```bash
brew install watchman
```

Linux (Ubuntu)
```bash
sudo apt update && sudo apt install watchman
```

Windows
Download the latest release from the https://github.com/facebook/watchman/releases and follow the instalation instructions.

## Basic Usage Guide
Once installed, you can verify Watchman is running:
```bash
watchman version
```

To start watching a directory:
```bash
watchman watch /path/to/directory
```

## Common Use Cases

Automated Asset Compilation
* Watchman can be used to automatically detect file changes and trigger actions like rebuilding assets (e.g., compiling JavaScript, CSS, or other project files)

Efficient Testing Workflows
* Many testing frameworks (such as Jest) integrate with Watchman to rerun tests whenever a file changes

* This speeds up the development process by allowing real-time feedback instead of manually restarting tests

Version Control Integration
* It can be used to track changes in Git repositories

* Watchman helps to identify modified files and can be configured to alert teams or run scripts when changes occur

File Synchornization and Backup
* Watchman can be used to monitor directories and sync changes across different environments

## Documentation

Head on over to https://facebook.github.io/watchman/
Expand Down