From 42a891276cf6452a8bc28fba70c3b93b871a344f Mon Sep 17 00:00:00 2001
From: Alinson S Xavier <axavier@anl.gov>
Date: Sat, 29 Aug 2020 18:08:32 -0500
Subject: [PATCH] Udpate docs

---
 VERSION       |  1 +
 docs/usage.md | 16 +++-------------
 mkdocs.yml    |  2 +-
 3 files changed, 5 insertions(+), 14 deletions(-)
 create mode 100644 VERSION

diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..6e8bf73
--- /dev/null
+++ b/VERSION
@@ -0,0 +1 @@
+0.1.0
diff --git a/docs/usage.md b/docs/usage.md
index 82986b9..fb97f47 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -1,20 +1,13 @@
 # Usage
 
-
 ### Installation
 
-MIPLearn is mainly written in Python, with some components written in Julia. For this
-reason, both Python 3.6+ and Julia 1.3+ are required. A mixed-integer solver is also required, and
-its Python bindings must be properly installed. Supported solvers are CPLEX and
-Gurobi. Optimization problems currently need to be specified in the Pyomo modeling language.
-A JuMP interface to the package is currently under development.
+In these docs, we describe the Python/Pyomo version of the package, although a [Julia/JuMP version](https://github.com/ANL-CEEESA/MIPLearn.jl) is also available. A mixed-integer solver is also required and its Python bindings must be properly installed. Supported solvers are currently CPLEX and Gurobi.
 
-To install MIPLearn, run the following commands: 
+To install MIPLearn, run: 
 
 ```bash
-git clone https://github.com/ANL-CEEESA/MIPLearn.git
-cd MIPLearn
-make install
+pip3 install miplearn
 ```
 
 After installation, the package `miplearn` should become available to Python. It can be imported
@@ -24,9 +17,6 @@ as follows:
 import miplearn
 ```
 
-!!! note
-    To install MIPLearn in another Python environment, switch to that environment before running `make install`. To install the package in development mode, run `make develop` instead.
-
 ### Using `LearningSolver`
 
 The main class provided by this package is `LearningSolver`, a learning-enhanced MIP solver which uses information from previously solved instances to accelerate the solution of new instances. The following example shows its basic usage:
diff --git a/mkdocs.yml b/mkdocs.yml
index 7f1d112..97daca1 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -2,7 +2,7 @@ site_name: MIPLearn
 theme: cinder
 copyright: "Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved."
 repo_url: https://github.com/ANL-CEEESA/MIPLearn
-edit_uri: edit/master/src/docs/
+edit_uri: edit/dev/docs/
 nav:
     - Home: index.md
     - Usage: usage.md