Skip to content

Commit 0a951e2

Browse files
authored
Merge pull request #19 from ddehilster/PACKAGE-PYTHON-008
PACKAGE-PYTHON-008 Updating the README.md
2 parents cffe198 + 41b5531 commit 0a951e2

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
11
# NLPPlus
22

3+
The NLPPlus Python Package is the package that allows for python scripts
4+
to call text and NLP analyzers created using [NLP++](https://visualtext.org). The package uses
5+
the C++ libraries for the [NLP Engine](https://github.com/VisualText/nlp-engine) making the calling more efficient than
6+
using the [NLP++ python class](https://github.com/VisualText/python) that calls command line version of the NLP
7+
Engine "nlp.exe".
8+
9+
The major advantage of NLPPlus over other NLP packages is that is 100%
10+
rule-based and modifiable and allows for any non-linguistic programmer
11+
to create text analyzers 100% taylored to their needs.
12+
13+
## Long-Term Open-Source, Glass-Box Project
14+
15+
NLP++ allows any programmer to write text and NLP programs that can be
16+
shared by everyone. It represents the first universal programming
17+
language for text and NLP. [As the community grows](https://nluglog.org), the number of open-source
18+
solutions including dictionaries, knowledge bases, and analyzers will
19+
grow - all of which can be modified by any programmer using the NLP++
20+
Language Extension for VSCode.
21+
322
## READ FIRST
423

5-
It is important to understand that the NLPPlus package for Python is very different from ALL other NLP packages
6-
in a very important and practical way.
24+
It is important to understand that the NLPPlus package for Python is very
25+
different from ALL other NLP packages in a very important and practical way.
726

827
Current NLP python packages have the "intention" of being plug-and-play
928
systems that perform natural language tasks without modification. The
@@ -51,16 +70,15 @@ around the world are starting to use NLP++ to write human digital readers for
5170

5271
## <span style='color:orange'>Installation</span>
5372

54-
### Future Installation (waiting for approval)
73+
### Installation
5574

56-
NLPPlus should eventually be installable from PyPI using pip, at which
57-
point you can simply run:
75+
NLPPlus can be installed using pip:
5876

5977
pip install nlpplus
6078

61-
### Installing By Downloading the Package (currently the only method)
79+
### Installing By Downloading the Package Manually
6280

63-
For the moment, you can find the installable "wheel" files under each
81+
You can find the installable "wheel" files under each
6482
release in the [Releases
6583
page](https://github.com/VisualText/py-package-nlpengine/releases/).
6684
Choose the correct version for your platform and Python version based
@@ -166,6 +184,8 @@ or JSON output from them:
166184

167185
### NLPPlus Engine Functions
168186

187+
These are the current functions that come with the NLPPlus package.
188+
169189
#### set_analyzer_folder(analyzer_folder_path: str)
170190
This is used to set the folder where your analyzers are located.
171191

0 commit comments

Comments
 (0)