Level / awesome

An open list of awesome Level modules and resources.
MIT License
294 stars 22 forks source link

Pull in all the wiki stuff? #1

Closed vweevers closed 5 years ago

vweevers commented 7 years ago

This is.. well, awesome, and could very well replace the levelup modules wiki page.

We could then also list compatibility with levelup@2 and/or abstract-leveldown@2.

And then put it on the website! :)

MeirionHughes commented 7 years ago

I didn't even know that was there, and I probably wouldn't have made this if I had known. Guess it might get more use if its an open-repo for people to add stuff and correct it.

Makes sense to go over everything to and list compatibility.

vweevers commented 7 years ago

Is there a way to automatically make badges like this?

abstract-leveldown version

vweevers commented 7 years ago

Had a look at the shields.io service. It's relatively easy to add new badges. For example the npm license badge queries the npm registry to get the license field from package.json.

In the same vein, a badge like https://img.shields.io/npm/dep/leveldown/abstract-leveldown.svg could request https://registry.npmjs.org/leveldown/latest to get the version range of abstract-leveldown.

vweevers commented 7 years ago

And color it green if up to date, orange if minor outdated, red if major outdated.

MeirionHughes commented 7 years ago

Ah okay cool, nice. 👍

vweevers commented 7 years ago

I also see a possibility here to explain the ecosystem, from easy to advanced.

I.e. put level at the top, saying "the main entry point for beginners - bundles levelup, encoding-down and leveldown". Then list levelup, with a description that conveys levelup is the glue, without undermining level. Then the stores, encoding-down, custom encodings, etc. End with the really low-level, half-compatible, gut-wrenchingly monkey-patched stuff.

It'll still be a succinct list. With a little bit of order and assuming each linked module has a good opening paragraph in their readme (encoding-down is currently lacking), it can be like a story. Helpful to both beginners and mad scientists.

Can later spruce it up with recipes, talks, popular dependents, what have you.

vweevers commented 7 years ago

WIP: https://github.com/Level/awesome/tree/more-awesome

ralphtheninja commented 7 years ago

Very nice. Maybe we could "refactor" out all the dependency badges out to the awesome repo?

vweevers commented 7 years ago

Maybe we could "refactor" out all the dependency badges out to the awesome repo?

Hmm not sure. In fact I'm not even sure awesome should have any badges. Might be too distracting, now that I look at it on GitHub

vweevers commented 7 years ago

No, scratch that thought. It's quite valuable here. For example the level-js badges clearly indicate it's outdated - and essentially say "you have to know what you're doing" but also "we need some help here :)". When evaluating different modules it's nice to have this overview.

MeirionHughes commented 7 years ago

Shame you can't get rid of the titles from each of the badges; they're somewhat redundant if you add the title to the table column.

I do like having an automated way to figuring out what is and isn't compatible / maintained.

vweevers commented 7 years ago

Shame you can't get rid of the titles from each of the badges; they're somewhat redundant if you add the title to the table column.

Very true, I looked everywhere but couldn't find an option that does this. It is possible if you add a logo instead of a label, but this currently requires adding a base64-encoded SVG to every badge

MeirionHughes commented 7 years ago

close... david

this is with ?label=  on the end

super nice work taming the links in the markdown btw. 👍

looks like getting rid of that left bit would need a PR and the issue is still open: https://github.com/badges/shields/issues/343

vweevers commented 7 years ago

3

vweevers commented 7 years ago

To add (after #3):

vweevers commented 7 years ago

@MeirionHughes do you think plugins like your levelup-async-iterator should peer-depend on levelup to express compatibility? We can then also derive badges from this

vweevers commented 6 years ago

Added a note to the wiki.