Merge pull request #28 from martinRenou/improve_docs

Improve docs

Author: martinRenou

README.md

@@ -1,4 +1,4 @@
-# jupyterlite-xeus-python-kernel
+# jupyterlite-xeus-python
 
 [![ci-badge]][ci] [![docs-badge]][docs]
 

docs/conf.py

@@ -7,7 +7,7 @@
 master_doc = 'index'
 source_suffix = '.rst'
 
-project = 'xeus-python-kernel'
+project = 'jupyterlite-xeus-python'
 copyright = 'JupyterLite Team'
 author = 'JupyterLite Team'
 

docs/configuration.rst

@@ -13,19 +13,19 @@ Requirements
 
 This feature requires you to have at least ``conda``, `mamba <https://github.com/mamba-org/mamba>`_ or ``micromamba`` installed.
 
-You also need to install ``emsdk``, this can be done by installing it from ``conda-forge``:
+You also need to install ``empack``, this can be done by installing it from ``conda-forge``:
 
 .. code::
 
-    conda install -c conda-forge emsdk
+    conda install -c conda-forge empack
 
     # OR
 
-    mamba install -c conda-forge emsdk
+    mamba install -c conda-forge empack
 
     # OR
 
-    micromamba install -c conda-forge emsdk
+    micromamba install -c conda-forge empack
 
 Usage
 ~~~~~
@@ -35,13 +35,13 @@ You can pre-install packages by passing the ``XeusPythonEnv.packages`` CLI optio
 .. note::
     This will automatically install any labextension that it founds, for example installing ipyleaflet will make ipyleaflet work without the need to manually install the jupyter-leaflet labextension.
 
-For example, say you want to install NumPy, Matplotlib and ipyleaflet, it can be done with the following command:
+For example, say you want to install ``NumPy``, ``Matplotlib`` and ``ipyleaflet``, it can be done with the following command:
 
 .. code::
 
     jupyter lite build --XeusPythonEnv.packages=numpy,matplotlib,ipyleaflet
 
-The same can be achieved through a `jupyterlite_config.json` file:
+The same can be achieved through a ``jupyterlite_config.json`` file:
 
 .. code::
 

docs/index.rst

@@ -1,5 +1,5 @@
-xeus-python in JupyterLite
-==========================
+xeus-python in JupyterLite 🚀🪐
+===============================
 
 The `xeus-python <https://github.com/jupyter-xeus/xeus-python>`_ kernel compiled to wasm and installable in JupyterLite!!
 
@@ -9,8 +9,15 @@ Features:
 - code completion
 - code inspection
 - interactive widgets (ipywidgets, ipyleaflet, bqplot, ipycanvas `etc`)
+- JupyterLite custom file-system mounting
+
+How does it compare with JupyterLite's ``Pyolite``?
+
 - ``from time import sleep`` works!
-- pre-installed packages: you can install the packages you want in your xeus-python lite installation (see :ref:`configuration` page)
+- starts faster!
+- it's lighter by default!
+- pre-installed packages! No more piplite (see :ref:`configuration` page)
+- no more piplite, but we will be working on a mambalite, stay stuned :D
 
 .. replite::
    :kernel: xeus-python