Update Documentation

[proffapt]

Update the format of documentation according to this

[Bikram-ghuku]

New build instructions

• Build from source (for development)

  1. Clone the repository

     git clone https://github.com/siddsarkar/iitkgp-erp-auto-login-extension.git

  2. Cd into the repository

     cd iitkgp-erp-auto-login-extension

  3. Install dependencies

     npm install

  4. Build the extension and watch for changes

     npm run start

  5. In a new terminal (once only)

     npm install --global web-ext # install web-ext globally

  6. The above step will create a addon folder with the extension in it.

     cd addon

  7. Run the extension using web-ext as below

     web-ext run # run the extension for firefox
     web-ext run -t chromium # (or) run the extension for chrome

  8. Check that the extension is loaded by opening the extensions page in Firefox about:addons or in Chrome chrome://extensions/.

[Bikram-ghuku]

• Build from source (for production)

  1. Clone the repository

     git clone https://github.com/siddsarkar/iitkgp-erp-auto-login-extension.git

  2. Cd into the repository

     cd iitkgp-erp-auto-login-extension

  3. Install dependencies

     npm install

  4. Build the extension and watch for changes

     npm run build-prod

  5. The above step will create a addon folder with the extension in it.

[Bikram-ghuku]

Please update the setup instructions to this in the README

[proffapt]

@Bikram-ghuku can you take up this issue? Make sure to follow the template of readme. And you can deviate in middle sections (refer to: iqps-go repository). And give proper credits to the original author.

[Bikram-ghuku]

Okay, sure

[proffapt]

Do it ASAP.