Merge pull request #39 from unlv-evol/dev

docs: updating documentation

README.md

@@ -7,10 +7,13 @@
 ![CI](https://github.com/unlv-evol/PyReprism/actions/workflows/ci.yml/badge.svg)
 ![Publish](https://github.com/unlv-evol/PyReprism/actions/workflows/publish.yml/badge.svg)
 [![codecov](https://codecov.io/gh/unlv-evol/PyReprism/graph/badge.svg?token=J2JV31837H)](https://codecov.io/gh/unlv-evol/PyReprism)
+![PyPI - Version](https://img.shields.io/pypi/v/pyreprism)
+![GitHub last commit (branch)](https://img.shields.io/github/last-commit/unlv-evol/pyreprism/main)
+
 
 # PyReprism
 
-PyReprism is a suite of essential methods designed for common preprocessing tasks in code clone detection research.
+PyReprism is a Python framework that helps researchers and developers the task of source code preprocessing. With PyReprism, you can easily match, extract, count, and remove comments, whitespaces, operators, numbers and other language specific constructs from over **150 programming languages and file extensions**.
 
 ## Install
 ```shell

docs/intro.rst

@@ -4,7 +4,7 @@
 Overview / Install
 ==================
 
-PyReprism is a Python framework that helps researchers and developers the task of source code preprocessing. With PyReprism, you can easily match, extract, count, and remove comments, whitespaces, operators, numbers and other language specific constructs from over 150 programming languages and file extension.
+PyReprism is a Python framework that helps researchers and developers the task of source code preprocessing. With PyReprism, you can easily match, extract, count, and remove comments, whitespaces, operators, numbers and other language specific constructs from over 150 programming languages and file extensions.
 
 
 Requirements

pyproject.toml

@@ -12,11 +12,11 @@ authors = [
 license={file="LICENSE" }
 python_requires = ">=3.5"
 description = "Framework for Source Code Preprocessing"
-readme = "README.md"
+readme = "PyReprism is a Python framework that helps researchers and developers the task of source code preprocessing. With PyReprism, you can easily match, extract, count, and remove comments, whitespaces, operators, numbers and other language specific constructs from over 150 programming languages and file extensions."
 requires-python = ">=3.6"
 classifiers = [
     "Environment :: Console",
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Stable,
     "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
     "Programming Language :: Python :: 3",
@@ -43,4 +43,5 @@ dev = [
 
 [project.urls]
 Homepage = "https://github.com/unlv-evol/PyReprism"
+Documentation = "https://pyreprism.readthedocs.io"
 Issues = "https://github.com/unlv-evol/PyReprism/issues"