Merge branch 'main' of https://github.com/joszamama/xatkit-api

Author: joszamama

README.md

@@ -28,10 +28,6 @@ Intended workflow explained:
 
 There are a few known bugs that we acknowledge, described in the projects section. If you detect any other new bug, please consider reporting it!
 
-<p align="right">(<a href="#top">back to top</a>)</p>
-
-
-
 ### Built With
 
 * [MongoDB](https://www.mongodb.com/)
@@ -44,7 +40,6 @@ There are a few known bugs that we acknowledge, described in the projects sectio
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 
-
 <!-- GETTING STARTED -->
 ## Getting Started
 
@@ -58,7 +53,7 @@ First, you will need to install [NPM](https://nodejs.org/en/download/), a [Mongo
 
 2. Install the NPM requisites:
   ```sh
-  $ cd xatkit-spl-backend
+  $ cd xatkit-spl-api
   $ npm install
   ```
 3. Update the .env file providing the different values shown in .env.example
@@ -68,25 +63,31 @@ First, you will need to install [NPM](https://nodejs.org/en/download/), a [Mongo
   $ npm start
   ```
 
-Then, you can access all the endpoints through an application like [Postman](https://www.postman.com/)
+Then, you can access all the endpoints through an application like [Postman](https://www.postman.com/), or using the Swagger UI in /docs.
 
-<p align="right">(<a href="#top">back to top</a>)</p>
+### Using the Tool
+
+Now, you can provide a valid Feature Model in UVL format, and a JSON file with information about the features in the model. You can take a look of the examples we provide in the bots/ExampleBot directory.
 
 ### Deploying a Chatbot
 
 Once the PL -> Intent -> Chatbot process has been completed with this tool, you will have access to a Dockerfile. For running your new chatbot, you will need to execute the following commands, having [Docker](https://docs.docker.com/desktop/) previously installed.
 
 1. Build the bot image:
   ```sh
-  $ docker build -t the_name_you_want_to_give_this_image . 
+  $ docker build -t newbot . 
   ```
 2. Run the chatbot:
   ```sh
-  $ docker run -t -i -p 5000:5000 -p 5001:5001 the_name_you_gave_before 
+  $ docker run -it -p 5000:5000 -p 5001:5001 newbot 
   ```
 
 Now you can access http://localhost:5000/admin and start chatting!
 
+### NLP Services
+
+If you want to take one step further and improve your bots adding a NLP layer, you will need to follow this [tutorial](https://github.com/xatkit-bot-platform/nlp.js-server). This Docker image will generate a NLP Server for Intent Recognition, and its ready to go, Xatkit-SPL will detect the server automatically and link the bots to it.
+
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 <!-- CONTRIBUTING -->