Ask HN: How do I improve boring README page?

• Apache AGE

  31 709 8.5 C

  Discontinued Graph database optimized for fast analysis and real-time data processing. It is provided as an extension to PostgreSQL. [Moved to: https://github.com/apache/age]

  

If you're referencing this: https://github.com/apache/incubator-age

Then I honestly think it's pretty good. Maybe two changes would be:

- Maybe embed one or two use comparisons of some search in plain SQL, and something using age to show what you can get. This both shows the wins, as well as shows people who already know cypher the general idea of how the languages two combine.

- As an incubating project, maybe talk a bit about roadmap. At what point will it no longer be incubating? What's the threshold? What are the risks of using an incubating project?

• awesome-readme

  30 16,961 6.9

  A curated list of awesome READMEs

Not only inspiration, there are various linked articles with good suggestions on how to write good readmes: https://github.com/matiassingers/awesome-readme#articles

• InfluxDB

  www.influxdata.com featured

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• Konva

  30 10,762 8.2 TypeScript

  Konva.js is an HTML5 Canvas JavaScript framework that extends the 2d context by enabling canvas interactivity for desktop and mobile applications.

  

Personally I'd like to see a quick start guide e.g. [1] shows me the bare minimum code needed to get it to work. I'm not a fan of projects that simply use one-liners like `docker run [link]` because it tells me nothing about what I (a developer) will see in my potential future workflow.

It would also be nice to see a comparison (performance, ease of use, etc.) with other frameworks on why I should use it vs whatever else comes up on Google

[1] https://github.com/konvajs/konva#quick-look

• pivottable

  4 4,301 3.8 CoffeeScript

  Open-source Javascript Pivot Table (aka Pivot Grid, Pivot Chart, Cross-Tab) implementation with drag'n'drop.

For my project (https://github.com/nicolaskruchten/pivottable) I adopted a simple Q&A approach: What does it do? Why is it good? How do I use it? ... folks seem to like it :)

• minio-py

  9 767 8.3 Python

  MinIO Client SDK for Python

  

Thank you for these points. I agree. It's one of those tools that, if you have that problem, you know exactly why you need it.

This solves this issue: https://github.com/minio/minio-py/issues/829. MinIO is an S3 compatible object storage software. https://min.io/

Thanks again.

• SaaSHub

  www.saashub.com featured

  SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

  

Suggest a related project