ipfs / ipfs/aegir

README doesn't have installation and/or getting started instructions

Open
#937 3 comments 0 reactions 1 assignee Claimed by @SgtPooki View on GitHub
help wanted kind/enhancement P1 topic/docs
Dominant language
JavaScript
Stars
105
Forks
62
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
I am starting a new project using aegir and noticed that there is no "getting started" or "installation" instructions.

**Describe the solution you'd like**
Provide a small snippet of instructions that inform users how to kick off a new project using aegir.

**Describe alternatives you've considered**
I figure I'm supposed to:

```bash
npm install -D aegir
mkdir -p src test ...

```
but...

1. what is next?
2. Is Item 1 above different for a typescript/esm/cjs/etc.. repo?
3. What about for an existing repo?
4. What tools does aegir replace?

**Additional context**
N/A

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.