Skip to content

Commit

Permalink
modified the README.md and updated the tarball location
Browse files Browse the repository at this point in the history
  • Loading branch information
Renien committed Jul 2, 2016
1 parent a88df7e commit f500c33
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Sample Recommendation

## Installation
```
$ pin install #TODO
$ pip install doc-diff
```

## Features
Expand All @@ -53,7 +53,7 @@ $ pin install #TODO
## Usage

- Allow to generate the evaluation result files
- Able to extratc the comparsion results as key-value list
- Able to extract the comparsion results as key-value list
- Using the diifferent dictionary objects you can present the results as you like (i.e Graphs, Venn diagram)

## Comparison Report Format
Expand All @@ -69,5 +69,27 @@ c973955 1965886,c340951,c752950,c973951||1965886,c24224,c340951,c752950,c906950,
c25749 c25982||c205950,c25982,c65977
```

## Package Directory Layout

```
doc-diff
├── LICENSE # Contains License Agreement file
├── README.md # Contains the details of doc-diff lib
├── doc_diff # Root package
│   ├── Diff.py # Diff class
│   ├── __init__.py # Package declaration
├── setup.py # Setup file for packaging
└── test # Test module (Includes the useage)
├── __init__.py # Package declaration
├── data # Sample data
│   ├── a-priori.csv # A-Priori algo results
│   └── pfp.csv # FP-Growth algo results
└── doc_diff_app.py # Main method file
```

## Contribute
NEED TO CHANGE !!
For any problem/question or if you think a feature that could make doc-diff lib more useful, do not hesitate to open an issue.

## License
MIT © [Renien](https://twitter.com/RenienJoseph)
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
author='Renien',
author_email='[email protected]',
license='MIT',
download_url = 'https://github.com/Renien/doc-diff/dist/1.0.0',
download_url = 'https://github.com/Renien/doc-diff/tarball/1.0.0',
keywords = ['doc-diff', 'DataScience', 'ComparingDocuments', 'ComparingAlgo'],
packages=find_packages(exclude=['test'])
)

0 comments on commit f500c33

Please sign in to comment.