<commit_before># Gitdocs

Collaborate on files and docs through a shared git repository. gitdocs will automatically push changes to the repo as well as pull in changes.
This allows any git repo to be used as a collaborative task list or wiki for a team.

You can also start a web front-end allowing the repo to be viewed through the browser.

## Installation

Install the gem:

```
gem install gitdocs
```

If you have Growl installed, you'll probably want to run `brew install growlnotify` to enable Growl support.

## Usage

First add the doc folders to watch:

```
gitdocs add my/path/to/watch
```

You can remove and clear paths as well:

```
gitdocs rm my/path/to/watch
# or gitdocs clear
```

You need to startup gitdocs:

```
gitdocs start
```

If the start command doesn't seem to properly start the process, you can run with a debug flag:

```
gitdocs start -D
```

You can also `stop` and `restart` gitdocs as needed. Run

```
gitdocs status
```

for a helpful listing of the current state. Once gitdocs is started, simply start editing or adding files to your
designated git repository. Changes will be automatically pushed and pulled to your local repo.

You can also have gitdocs fetch a remote repository with:

```
gitdocs create my/path/for/doc git@github.com:user/some_docs.git
```

This will clone the repo and add the path to your watched docs. Be sure to restart gitdocs
to have path changes update:

```
gitdocs restart
```

To view the docs in your browser with file formatting:

```
gitdocs serve
```

and then visit `http://localhost:8888` for access to all your docs in the browser.

## Planned Features

 - A web UI for uploading, and editing text files (in addition to viewing)
 - Local-area peer-to-peer sync.
 - Click-to-share instant access granting.
 - Better conflict-resolution behavior (maintains both versions of a file)
 - Support for linux and windows (coming soon)<commit_msg>Adds more notes to planned features<commit_after># Gitdocs

Collaborate on files and docs through a shared git repository. gitdocs will automatically push changes to the repo as well as pull in changes.
This allows any git repo to be used as a collaborative task list or wiki for a team. 
You can also start a web front-end allowing the repo to be accessed through a browser.

## Installation

Install the gem:

```
gem install gitdocs
```

If you have Growl installed, you'll probably want to run `brew install growlnotify` to enable Growl support.

## Usage

First add the doc folders to watch:

```
gitdocs add my/path/to/watch
```

You can remove and clear paths as well:

```
gitdocs rm my/path/to/watch
# or gitdocs clear
```

You need to startup gitdocs:

```
gitdocs start
```

If the start command doesn't seem to properly start the process, you can run with a debug flag:

```
gitdocs start -D
```

You can also `stop` and `restart` gitdocs as needed. Run

```
gitdocs status
```

for a helpful listing of the current state. Once gitdocs is started, simply start editing or adding files to your
designated git repository. Changes will be automatically pushed and pulled to your local repo.

You can also have gitdocs fetch a remote repository with:

```
gitdocs create my/path/for/doc git@github.com:user/some_docs.git
```

This will clone the repo and add the path to your watched docs. Be sure to restart gitdocs
to have path changes update:

```
gitdocs restart
```

To view the docs in your browser with file formatting:

```
gitdocs serve
```

and then visit `http://localhost:8888` for access to all your docs in the browser.

## Planned Features

Gitdocs is a young project but we have big plans for it including:

 - A web UI for easy uploading, and editing of files (in addition to viewing)
 - Local-area peer-to-peer syncing, avoiding 'polling' in cases where we can.
 - Click-to-share instant access granting using a local tunnel or other means.
 - Better conflict-resolution behavior (maintains both versions of a file)
 - Support for linux and windows (coming soon)
{'fraction_non_alphanumeric': 0.06946526736631684, 'fraction_numerical': 0.001999000499750125, 'mean_word_length': 3.9975031210986267, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5053145', 'n_tokens_mistral': 1155, 'n_tokens_neox': 1076, 'n_words': 602}