<commit_before>== Introduction

Diract (DIRectory ACTions) is a command line utility for managing "@action" folders.

There are plenty todo-list aplications that sotore todo's in text, xml, other files or databases.
Many of them allow you to link something (a file, url etc..) to your task item.
But what if it's too much effort? Why not other way around?

Use case:
You browse internet, find some cool aplication, pdf for later reading, image you want to proces.
You download the file and decide you will go back to it later. You finish browsing downloading some more files in meantime, look at those files and still remember what to do with them.
You drop the files into @action folder so you remember to go back to it later.
A week later you come back to your @action and you find diyp3h_harmony_aio_1.pdf in you folder. You have action item that sais "review those new templates for weekly shedule". But you didn't link this item to specific files so you neither know what to do with the file or how to complete you action.  The goal of having todo list (or to-be-done list) is not having to rethink everything later. 

Diract offers aided way for such use case. It assigns description to a file.
Using diract's commands you can easily list, comment, delete files from predefined folders.
In previous example you instead of creating todo item you would add description to file directly. You can later easily import those descriptions to your favorite todo app.
== Instalation

Diract requires ruby v1.9.1 or greater.

Target is to put this app to gems repository, for now (untill first version is released) use:
   rake install

== Configuration

After first call diract creates (if not already exists) .diractrc in HOME folder.
It is simple list with folder paths.
Edit the file and place location(s) of your action folder(s).

== Usage

To list action items 
   diract [list]

To comment item:
   diract <id> -c comment
where <id> is completed with folder letter and item number (list items to see how diract assigns them)

To delete item:
   diract <id> -d

== Contributing to diract
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Copyright

Copyright (c) 2011 <NAME>. See LICENSE.txt for
further details.

<commit_msg>readme updated<commit_after>= Diract

Diract (DIRectory ACTions) is a command line utility for managing "@action" folders.

== Introduction

There are plenty todo-list aplications that sotore todo's in text, xml, other files or databases.
Many of them allow you to link something (a file, url etc..) to your task item.
But what if it's too much effort? Why not other way around?

Use case:
You browse internet, find some cool aplication, pdf for later reading, image you want to proces.
You download the file and decide you will go back to it later. You finish browsing downloading some more files in meantime, look at those files and still remember what to do with them.
You drop the files into @action folder so you remember to go back to it later.
A week later you come back to your @action and you find diyp3h_harmony_aio_1.pdf in you folder. You have action item that sais "review those new templates for weekly shedule". But you didn't link this item to specific files so you neither know what to do with the file or how to complete you action.  The goal of having todo list (or to-be-done list) is not having to rethink everything later. 

Diract offers aided way for such use case. It assigns description to a file.
Using diract's commands you can easily list, comment, delete files from predefined folders.
In previous example you instead of creating todo item you would add description to file directly. You can later easily import those descriptions to your favorite todo app.
== Instalation

Diract requires ruby v1.9.1 or greater.

Target is to put this app to gems repository, for now (untill first version is released) use:
   rake install

== Configuration

After first call diract creates (if not already exists) .diractrc in HOME folder.
It is simple list with folder paths.
Edit the file and place location(s) of your action folder(s).

== Usage

To list action items 
   diract [list]

To comment item:
   diract <id> -c comment
where <id> is completed with folder letter and item number (list items to see how diract assigns them)

To delete item:
   diract <id> -d

== Contributing to diract
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Copyright

Copyright (c) 2011 <NAME>. See LICENSE.txt for
further details.


{'fraction_non_alphanumeric': 0.0449497620306716, 'fraction_numerical': 0.0031729243786356425, 'mean_word_length': 4.079677708146821, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3454183', 'n_tokens_mistral': 1493, 'n_tokens_neox': 1423, 'n_words': 942}