You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2020/03/06 17:23:37 UTC

[incubator-nlpcraft-ui] branch master updated: README update.

This is an automated email from the ASF dual-hosted git repository.

aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-ui.git


The following commit(s) were added to refs/heads/master by this push:
     new 7a9a697  README update.
7a9a697 is described below

commit 7a9a697075bb4ce2890e6bb524c575d3d364bbe8
Author: Aaron Radzinzski <ar...@datalingvo.com>
AuthorDate: Fri Mar 6 09:23:34 2020 -0800

    README update.
---
 README.md | 37 +++++++++++++++++++++++--------------
 1 file changed, 23 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 8274bb2..b6cf5b4 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,54 @@
 <img src="https://nlpcraft.org/images/nlpcraft_logo_black.gif" height="80px">
 <br>
-<a target=_ href="https://gitter.im/nlpcraftorg/community"><img alt="Gitter" src="https://badges.gitter.im/nlpcraftorg/community.svg"></a>
+<a target=_ href="https://gitter.im/apache-nlpcraft/community"><img alt="Gitter" src="https://badges.gitter.im/nlpcraftorg/community.svg"></a>
 
-# Web-based UI for NLPCraft
+## What is Apache NLPCraft?
+[Apache NLPCraft](https://nlpcraft.org/) is an open source library for adding a natural language interface to any applications. 
+NLPCraft is free and developer friendly, it securely works with any private data source, and has no hardware or software 
+lock-in.
 
 ## Live Version
-
 [https://nlpcrafters.github.io/nlpcraft-ui/](https://nlpcrafters.github.io/nlpcraft-ui/)
 
 ## Software Requirements
-
 - [NodeJS 8+](https://nodejs.org)
 - [Yarn 1.19+](https://yarnpkg.com)
 - [TypeScript](https://www.typescriptlang.org/)
 - [Angular CLI](https://cli.angular.io/)
 
-## Install dependencies
-  
+## Install Dependencies  
  - Run `yarn install`
 
-## Prepare (Run only once)
-
+## Prepare (Run Only Once)
  - Run `ng set --global packageManager=yarn` - configures Angular CLI to use Yarn
  - Run `yarn` - initializes dependencies
 
-## Build and minifies for the production
-
+#### Production Mode
  - Run `yarn build` 
  - See `dist/web-app` folder for build results 
 
  
-## Development mode
-
+#### Development Mode
  - Run `yarn start` 
  - Open browser at [http://localhost:4200](http://localhost:4200)
 
+## Questions, Feedback or Suggestions
+ * Post a question at [Stack Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code> tag
+ * Access [GitHub](https://github.com/apache/incubator-nlpcraft-ui) mirror repository.
+ * Ask questions on [dev@nlpcarft.apache.org](mailto:dev@nlpcarft.apache.org)
+ 
+#### Other Projects
+- [Apache NLPCraft](https://github.com/apache/incubator-nlpcraft) - main NLPCraft project.
+- [Apache NLPCraft UI](https://github.com/apache/incubator-nlpcraft-java-client) - Native Java client for NLPCraft REST APIs.
 
 ## Browsers support
-
 Modern browsers and Internet Explorer 10+.
 
 | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/mas [...]
 | --------- | --------- | --------- | --------- |
-| IE 9-11, Edge| last 2 versions| last 2 versions| last 2 versions
\ No newline at end of file
+| IE 9-11, Edge| last 2 versions| last 2 versions| last 2 versions
+
+### Copyright
+Copyright (C) 2020 Apache Software Foundation
+
+<img src="https://www.apache.org/img/ASF20thAnniversary.jpg" height="64px">
\ No newline at end of file