docs: update README and CONTRIBUTING

- fix typos, update urls and info

Author: gamemaker1

CONTRIBUTING.md

@@ -1,29 +1,40 @@
-# Contributing to Dabbu
+# Contributing to Dabbu Files API Server
 
 First off, thanks for taking the time to contribute!
 
-The following is a set of guidelines for contributing to Dabbu. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
+The following is a set of guidelines for contributing to Dabbu Files API Server. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
 
 ## Issues
 
-You can contribute to Dabbu by reporting bugs, fixing bugs, adding features, and spreading the word! If you want to report a bug, create an issue by clicking [here](https://github.com/dabbu-knowledge-platform/files-api-server/issues/new/choose). While creating an issue, try to follow the Bug report or Feature request template.
+You can contribute to Dabbu Files API Server by reporting bugs, fixing bugs, adding features, and spreading the word! If you want to report a bug, create an issue by clicking [here](https://github.com/dabbu-knowledge-platform/files-api-server/issues/new/choose). While creating an issue, try to follow the Bug report or Feature request template.
 
 ## Pull requests
 
-### Step 0: Install `git`, `nodejs` and `npm`
+This guide assumes you are familiar with Github and the command line. If not, [here](https://guides.github.com/activities/hello-world/) is a guide to get started with Github. If you are stuck on something, feel free to ask on [Github Discussions](https://github.com/dabbu-knowledge-platform/cli/discussions/categories/want-to-contribute).
 
-- `git` **must** be installed to make pull requests and push changed code.
-  - To check if git is already installed, type `git --version` in terminal/command prompt. You should see a version number displayed after running this command.
-  - [Here](https://github.com/git-guides/install-git) are the official instructions to install git for all platforms in case you haven't installed it already.
-- `nodejs and npm` **must** be installed to run the server locally
-  - To check if nodejs is already installed, type `node --version && npm --version` in terminal/command prompt. You should see two version numbers displayed after running this command.
-  - [Here](https://nodejs.org/en/download/package-manager/) are the official instructions to install nodejs and npm for all platforms in case you haven't installed it already.
+### Step 0: Environment
+
+Install `git`, `nodejs` and `npm`.
+
+#### Git
+
+`git` **must** be installed to make pull requests and push changed code.
+
+- To check if git is already installed, type `git --version` in terminal/command prompt. You should see a version number displayed after running this command.
+- [Here](https://github.com/git-guides/install-git) are the official instructions to install git for all platforms in case you haven't installed it already.
+
+#### NodeJS and NPM
+
+`nodejs` and `npm` **must** be installed to run the CLI locally.
+
+- To check if NodeJS and NPM already installed, type `node --version && npm --version` in terminal/command prompt. You should see two version numbers displayed after running this command. For developing Dabbu CLI, we use the LTS version of NodeJS (v14.x)
+- [Here](https://nodejs.org/en/download/package-manager/) are the official instructions to install NodeJS and NPM for all platforms in case you haven't installed it already.
 
 ### Step 1: Fork
 
 Fork the project [on the GitHub website](https://github.com/dabbu-knowledge-platform/files-api-server) and clone your fork locally.
 
-Run the following to clone your fork locally:
+Run the following in a terminal to clone your fork locally:
 
 ```sh
 $ git clone https://github.com/<your-username>/files-api-server
@@ -34,7 +45,7 @@ $ git fetch upstream
 
 ### Step 2: Build
 
-All you need to do to build is run `npm run build`. If the command runs successfully, there should be 3 files (`files-api-server-linux`, `files-api-server-macos` and `files-api-server-win.exe`) in the `dist/` folder. These are the executables that can be run on linux, macos and windows respectively without installation of external dependencies.
+All you need to do to build is run `npm run build`. If the command runs successfully, there should be 4 files (`dabbu-cli-alpine`, `dabbu-cli-linux`, `dabbu-cli-macos` and `dabbu-cli-win.exe`) in the `dist/` folder. These are the executables that can be run on alpine, linux, macos and windows respectively without installation of external dependencies.
 
 Once you've built the project locally, you're ready to start making changes!
 
@@ -50,7 +61,7 @@ $ git checkout -b add-awesome-new-feature -t upstream/main
 
 To get a decent idea of how the code is organised and what happens where, the code is heavily commented to allow you to understand exactly what happens. Remember to always format the code using `prettier` once you're done.
 
-To test a change without building the executables, you can type `npm start` and it will run the server directly.
+To test a change without building the executables, you can type `npm start` and it will run the server directly. Use an HTTP client like `httpie` or `postman` to test the API.
 
 To check if the code is formatted correctly, run `npm run check-format`. To format the code using prettier, run `npm run format`.
 
@@ -65,7 +76,7 @@ $ git commit
 
 Note that multiple commits often get squashed when they are landed.
 
-**Commit message guidelines**
+#### Commit message guidelines
 
 A good commit message should describe what changed and why. This project uses [semantic commit messages](https://conventionalcommits.org/) to streamline
 the release process.
@@ -115,23 +126,29 @@ This ensures that your working branch has the latest changes from `dabbu-knowled
 
 ### Step 7: Test
 
-Bug fixes and features should always come with tests. Please test your own code adequately. Also, before finally pushing your code, clone it into a fresh environment (different user or maybe a different computer) and make sure it works just as fine. Make sure you test the executables in the `dist/` directory, not just the \*.js files.
+Bug fixes and features should always come with tests. Please test your own code adequately. Also, before finally pushing your code, clone it into a fresh environment (different user or maybe a different computer) and make sure it works just as fine. Make sure you test the executables in the `dist/` directory.
+
+### Step 8: Document
+
+Once your commits are ready to go - with adequate testing - begin the process of documenting your code. The code **must** be heavily commented, so future contributors can move around and make changes easily.
+
+Make sure all the changes you make are in accordance with the [Files API Specifications](https://dabbu-knowledge-platform.github.io/files_api/). If you wish to make changes to the API specification itself, drop a message [here](https://github.com/dabbu-knowledge-platform/cli/discussions/categories/general) and we can start discussing the changes.
 
-### Step 8: Push
+### Step 9: Push
 
 Once you have documented your code as required, begin the process of opening a pull request by pushing your working branch to your fork on GitHub.
 
 ```sh
 $ git push origin add-awesome-new-feature
 ```
 
-### Step 9: Opening the Pull Request
+### Step 10: Opening the Pull Request
 
-From within GitHub, opening a new pull request will present you with a template that should be filled out.
+From within GitHub, opening a [new pull request](https://github.com/dabbu-knowledge-platform/files-api-server/compare) will present you with a template that should be filled out.
 
-### Step 10: Discuss and update
+### Step 11: Discuss and update
 
-You will probably get feedback or requests for changes to your pull request. This is a big part of the submission process so don't be discouraged! Some contributors may sign off on the pull request right away. Others may have detailed comments or feedback. This is a necessary part of the process in order to evaluate whether the changes are correct and necessary.
+You will probably get feedback or requests for changes to your pull request. This is a big part of the submission process, so don't be discouraged! Some contributors may sign off on the pull request right away. Others may have detailed comments or feedback. This is a necessary part of the process in order to evaluate whether the changes are correct and necessary.
 
 To make changes to an existing pull request, make the changes to your local branch, add a new commit with those changes, and push those to your fork. GitHub will automatically update the pull request.
 
@@ -141,18 +158,18 @@ $ git commit
 $ git push origin add-awesome-new-feature
 ```
 
-There are a number of more advanced mechanisms for managing commits using `git rebase` that can be used, but are beyond the scope of this README.
+There are a number of more advanced mechanisms for managing commits using `git rebase` that can be used, but are beyond the scope of this guide.
 
 Feel free to post a comment in the pull request to ping reviewers if you are awaiting an answer on something.
 
 **Approval and Request Changes Workflow**
 
-All pull requests require approval from an organization member in order to land. Whenever a maintainer reviews a pull request they may request changes. These may be small, such as fixing a typo, or may involve substantive changes. Such requests are intended to be helpful, but at times may come across as abrupt or unhelpful, especially if they do not include concrete suggestions on _how_ to change them.
+All pull requests require approval from contributors in order to land. Whenever a maintainer reviews a pull request they may request changes. These may be small, such as fixing a typo, or may involve substantive changes. Such requests are intended to be helpful, but at times may come across as abrupt or unhelpful, especially if they do not include concrete suggestions on _how_ to change them.
 
 Try not to be discouraged. Try asking the maintainer for advice on how to implement it. If you feel that a review is unfair, say so or seek the input of another project contributor. Often such comments are the result of a reviewer having taken insufficient time to review and are not ill-intended. Such difficulties can often be resolved with a bit of patience. That said, reviewers should be expected to provide helpful feedback.
 
-### Step 11: Landing
+### Step 12: Landing
 
-In order to land, a pull request needs to be reviewed and approved by at least one Code Owner. After that, if there are no objections from other contributors, the pull request can be merged.
+In order to land, a pull request needs to be reviewed and approved by at least one contributor. After that, if there are no objections from other contributors, the pull request can be merged.
 
 **Congratulations and thanks a lot for your contribution!**

README.md

@@ -1,6 +1,6 @@
 # Dabbu Files API Server
 
-[![Code Style and Build Check](https://github.com/dabbu-knowledge-platform/files-api-server/actions/workflows/style_and_build_check.yml/badge.svg)](https://github.yungao-tech.comdabbu-knowledge-platform/files-api-server/actions/workflows/style_and_build_check.yml)
+[![NodeJS CI](https://github.com/dabbu-knowledge-platform/files-api-server/actions/workflows/ci.yml/badge.svg)](https://github.yungao-tech.comdabbu-knowledge-platform/files-api-server/actions/workflows/ci.yml)
 
 An implementation of the Dabbu Files API that enables you to access your files, folders and emails stored with multiple providers as simple files and folders, all in one place!
 
@@ -10,13 +10,15 @@ Tired of having your files and folders randomly scattered about online with mult
 
 ![](./media/DabbuCLI.gif)
 
+<sub>Dabbu CLI retrieving files from Google Drive [Note: this GIF is outdated]</sub>
+
 What you just saw there was Dabbu CLI in action - a simple program in javascript that leverages the Dabbu API to bring your files and folders at your fingertips from all over the web.
 
 **This repo contains the server application that handles API calls from clients. The source for the CLI app demoed in the GIF above can be found [here](https://github.com/dabbu-knowledge-platform/cli).**
 
 ## Getting started
 
-The installation can be done manually on Linux, MacOS, Android (Requires Termux) and Windows.
+The installation can be done manually on Linux, Alpine Linux, MacOS, Android (Requires Termux) and Windows (Currently only 64-bit architectures are supported).
 
 Follow the instructions [here](https://dabbu-knowledge-platform.github.io/impls/server) to install it on your computer.
 
@@ -41,17 +43,21 @@ _And more to come...!_
 
 ### Creating a new provider
 
-**Note: If you want to create a new provider, please file an issue using the `New provider` template [here](https://github.com/dabbu-knowledge-platform/files-api-server/issues/new/choose). This is only to let us know that you want to work on the provider and how you plan to go about it. Also, if you need any help on the code, please do ask on [this](https://github.com/dabbu-knowledge-platform/files-api-server/discussions/categories/want-to-contribute) Github discussion. We will only be glad to help :)**
+If you want to create a new provider, please file an issue using the `New provider` template [here](https://github.com/dabbu-knowledge-platform/files-api-server/issues/new/choose). This is only to let us know that you want to work on the provider and how you plan to go about it.
+
+Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for a detailed guide to setting up your environment and making changes to the code.
+
+Also, if you need any help on the code, please do ask on [this](https://github.com/dabbu-knowledge-platform/files-api-server/discussions/categories/want-to-contribute) Github discussion. We will only be glad to help :)
 
 ## Docs
 
-The documentation for the server can be found [here](https://dabbu-knowledge-platform.github.io/impls/server).
+The documentation for the server can be found on the [website](https://dabbu-knowledge-platform.github.io/impls/server). The source can be found [here](https://github.com/dabbu-knowledge-platform/dabbu-knowledge-platform.github.io/blob/main/impls/server.md).
 
 ## Issues and pull requests
 
 You can contribute to Dabbu by reporting bugs, fixing bugs, adding features, and spreading the word! If you want to report a bug, create an issue by clicking [here](https://github.com/dabbu-knowledge-platform/files-api-server/issues/new/choose). While creating an issue, try to follow the Bug report or Feature request template.
 
-To contribute code, have a look at [CONTRIBUTING.md](./CONTRIBUTING.md).
+Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for a detailed guide to setting up your environment and making changes to the code.
 
 ## Legal stuff