search

DAVFoundation / dav-js

Enable integration of JavaScript, TypeScript, and Node.js code with the DAV Network
https://developers.dav.network/
MIT License
76 stars 51 forks source link

Add installation and usage instructions to the Readme #120

Closed looeee closed 1 year ago

looeee commented 5 years ago

Expected Behavior

The Readme should include the basic step required to install and setup a new project. The most difficult part of connecting with a new project is often the setup, and if there are a list of simple steps to follow that helps new users a lot.

Current Behavior

The Readme is not helpful to new users.

Possible Solution

Two new sections should be added:

  1. Installation

  2. Usage, or creation of a basic project

Alternatively, if there is already a document describing these steps elsewhere, the Readme should link to it.

TalAter commented 5 years ago

I think we need to distinguish between two types of documents.

  1. Documentation that explains how to use dav-js to build something.
  2. A CONTRIBUTING.md document which explains how to get started contributing to and modifying dav-js itself.

The first is available in our developers site, although it is still lacking a section explaining the basics of how to get started with it.

The second is definitely needed and it would be great if you could create.