Merge pull request #71 from meilisearch/prepare_for_npm_release

Prepare project for npm release

CONTRIBUTING.md

@@ -22,10 +22,10 @@ yarn playground:default
 ```
 
 Running this mode has two effects.
+
 - If you change the source code of the docusaurus playground, the docusaurus app restarts.
 - If you change the source code of scrapix, scrapix is rebuilded and re-runs a scrapper (either the default one or the docsearch one) on the docusaurus app.
 
-
 # Re-scrap a chosen app on change
 
 If you which to re-scrap an app based on a custom scrapix configuration file, run the following:
@@ -35,3 +35,12 @@ npx nodemon --watch src --watch "[PATH_TO_YOUR_CONFIG_FILE]" --ext ts,json --exe
 ```
 
 This will scrap an app based on the provided "PATH_TO_YOUR_CONFIG_FILE" on every change in the `./src` folder and on your provided config file.
+
+## Publish
+
+To publish scrapix to npm. Increase its version and then:
+
+```sh
+yarn build
+npm publish .
+```

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "scrapix",
+  "name": "@meilisearch/scrapix",
   "version": "0.0.1",
-  "description": "This is an example of a Crawlee project.",
+  "description": "Automatic scraper and indexer to Meilisearch of any website.",
   "main": "dist/src/index.js",
   "dependencies": {
     "axios": "^1.4.0",