fix: Update and rename README.md to README.rst

src/ol_social_auth/README.rst

@@ -0,0 +1,51 @@
+Open Learning Social Auth
+=======================
+
+An Open edX plugin implementing MIT social auth backend
+
+Version Compatibility
+---------------------
+
+Compatible with the Nutmeg release of the Open edX and onwards. May work with prior releases as well.
+
+Installing The Plugin
+---------------------
+
+You can install this plugin into any Open edX instance by using any of the following methods:
+
+**Option 1: Install from PyPI**
+
+.. code-block::
+
+    # If running devstack in docker, first open a shell in LMS (make lms-shell)
+
+    pip install ol-social-auth
+
+
+**Option 2: Build the package locally and install it**
+
+Follow these steps in a terminal on your machine:
+
+1. Navigate to ``open-edx-plugins`` directory
+2. If you haven't done so already, run ``./pants build``
+3. Run ``./pants package ::``. This will create a "dist" directory inside "open-edx-plugins" directory with ".whl" & ".tar.gz" format packages for all plugins in the src directory
+4. Move/copy any of the ".whl" or ".tar.gz" files for this plugin that were generated in the above step to the machine/container running Open edX (NOTE: If running devstack via Docker, you can use ``docker cp`` to copy these files into your LMS or CMS containers)
+5. Run a shell in the machine/container running Open edX, and install this plugin using pip
+
+
+``Note``: In some cases you might need to restart edx-platform after installing the plugin to reflect the changes.
+
+Configurations
+--------------
+This section outlines the steps for integrating your application with ol-social-auth for various deployment scenarios. Please refer to the corresponding documentation for detailed instructions.
+
+* **MITxPRO:** To configure ol-social-auth with MITxPRO, follow the comprehensive guide available `here <https://github.com/mitodl/mitxpro/blob/master/docs/configure_open_edx.md>`_
+* **MITxOnline:** For integration with MITxOnline, detailed instructions can be found in the official documentation `here <https://github.com/mitodl/mitxonline/blob/main/docs/source/configuration/open_edx.rst>`_
+* **MITxOnline with Tutor:** If you're using MITxOnline with Tutor for development purposes, specific configuration steps are outlined in the `documentation <https://github.com/mitodl/mitxonline/blob/main/docs/source/configuration/tutor.rst>`_
+
+
+Working
+--------
+* Install the plugin in the lms following the installation steps above.
+* Verify that you are not logged in on edx-platform.
+* Create a new user in your MIT application and verify that a corresponding user is successfully created on the edX platform.