README: what it is, what it does

[hackergrrl]

Since this module is going to be used so widely across IPFS, I expect many current & prospective contributors to be funneled to this repo at one point or another. As such, I'd be really interested in seeing the README be very clear about

a. what is dignified.js? and
b. what problems does it solve?

Right now it does a very good job of explaining its subcommands and setting it up, but having Background and Description sections that explain a bit more could save @dignifiedquire the work of explaining things many more times via IRC or elsewhere.

[dignifiedquire]

This was mainly written down in here: ipfs/community#111 and I'm waiting for that to be finalized to pull in the details here.

[hackergrrl]

Awesome! Getting these ideas merged into the README would be very helpful.

[daviddias]

Feels like this is done now :) Reopen if I'm mistaken

[hackergrrl]

Heya @diasdavid 👋

(I don't seem to have permissions to re-open, fyi.)

I'm not sure anything's changed w.r.t. the README. The Github short-text is a URL, and the project tagline below is "Automated JavaScript project management". Here are some questions that a great README could address right off the bat:

1. what is aegir? (subtext: "what does 'automated js project management' mean?")
2. what areas of project management does it cover?
3. "Stack Requirements" mentions aegir's "many benefits" -- what are they?

You'll have new visitors here all the time, who may not have background with using aegir in IPFS projects. This could be their first exposure to this module. Aegir provides a lot of functionality based on the experience of its developers: the README is an excellent place to share that wisdom. 😀 You may get some mileage out of Art of README, too!

[JonKrone]

+1 on this. Ever since running my first test on js-ipfs, I've been curious about what Aegir was and why we use it. I've looked at this package a few times but didn't really get a sense of why we built it over using other tools independently.

I think all of @noffle suggestions are really sound directions for whoever tackles this.

[hackergrrl]

Has this been fixed?