Readme doesn't really say what the project is

[alessandroargentieri]

Problem

The README starts with explaining what are the advantages of Tachyon and how to integrate it, but it doesn't say a word on what it is.

Proposed solution

Write the Readme for technical and non-technical audiences, explaining first what exactly the project is, in what category of projects it goes (e.g. a library, a framwork, a standalone process) what is meant for and what problem it solves.

Are you willing to implement this?

• Yes
• No

[riyaneel]

Hi,

I completely agree with you. I am currently overhauling the documentation for the v0.6.0 release. The root README will be entirely rewritten to explicitly define Tachyon (an ultra-low-latency shared-memory IPC library), its architectural scope, and its exact use cases before detailing the performance metrics.