Merge pull request #173 from Ayushk4/docs_readme

Readme updated. Docs edited to provide API Reference online.

Author: aviks

NEWS.md

@@ -0,0 +1,11 @@
+
+- Average Perceptron Part-of-Speech Tagger Added
+- Named Entity Recognition and Part of Speech Tagging APIs added.
+- Linear Chain Conditional Random Fields for support over Flux.
+- BM25, Co-occurence Matrix added and Latent Semantic Analysis fixed.
+- Naive Bayes Classifier added.
+- Offline Documentation added to the codebase
+
+# 0.6.0
+
+Pre- 0.6.0 history is not available.

README.md

@@ -1,10 +1,41 @@
-
-TextAnalysis
-============
+# TextAnalysis
 
 A Julia package for working with text.
 
 [![Travis](https://travis-ci.org/JuliaText/TextAnalysis.jl.svg?branch=master)](https://travis-ci.org/JuliaText/TextAnalysis.jl)
 [![Appveyor](https://ci.appveyor.com/api/projects/status/aviks/textanalysis-jl?svg=true)](https://ci.appveyor.com/project/aviks/textanalysis-jl)
-<!-- [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliatext.github.io/TextAnalysis.jl/stable) -->
+<!--[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliatext.github.io/TextAnalysis.jl/stable) -->
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliatext.github.io/TextAnalysis.jl/dev)
+[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliatext.github.io/TextAnalysis.jl/latest)
+
+Please see the detailed `manual` and `API Documentation` for the linked above. The package also comes with a set of `docstrings` for offline documentation access.
+
+## Introduction
+
+TextAnalysis provides support for standard tools and models for working with textual data and natural languages in the Julia langauges. Please see the [documentation](https://juliatext.github.io/TextAnalysis.jl/latest) for more.
+
+- **Features** : Refer to NEWS.md for the latest features.
+- **License** : [MIT License](https://github.com/JuliaText/TextAnalysis.jl/blob/master/LICENSE.md)
+
+## Installation
+
+```julia
+pkg> add TextAnalysis
+```
+
+You may want to work on the master branch for the latest features (as mentioned in NEWS.md).
+
+```julia
+pkg> add TextAnalysis#master
+```
+
+## Contributing and Reporting Bugs
+
+Contributions, in the form of bug-reports, pull requests, additional documentation are encouraged. They can be made to the Github repository.
+
+**All contributions and communications should abide by the [Julia Community Standards](https://julialang.org/community/standards/).**
+
+## Support
+
+Feel free to ask for help on the [Julia Discourse forum](https://discourse.julialang.org/), or in the `#natural-language` channel on [julia-slack](https://julialang.slack.com). (Which you can [join here](https://slackinvite.julialang.org/)). You can also raise issues in this repository to request new features and/or improvements to the documentation and codebase.
+

docs/make.jl

@@ -18,7 +18,8 @@ makedocs(
         "Extended Example" => "example.md",
         "Evaluation Metrics" => "evaluation_metrics.md",
         "Conditional Random Fields" => "crf.md",
-        "Named Entity Recognition" => "ner.md"
+        "Named Entity Recognition" => "ner.md",
+        "API References" => "APIReference.md"
     ],
 )
 

docs/src/APIReference.md

@@ -0,0 +1,6 @@
+# API References
+
+```@autodocs
+Modules = [TextAnalysis]
+Order   = [:function, :type]
+```