Add an informative README about streameth-platform HOT 2 CLOSED

I dont think this needs to be a user story but it can be just a task. User stories are feature descriptions for user of the application itself

Also, I would define what kind of info we want on the readme. IMO the readme should help other developers use streameth and contribute to it

from streameth-platform.

Here are the key points I am aiming to address:

1. Website Additions:

   • We're looking to include streameth.org and app.streameth.org into our documentation to provide users and contributors with a clearer understanding of our platform's public and app-specific functionalities.

2. Contribution Guidelines:

   • A "How to Contribute" section is crucial. This will include details on submitting issues, pull requests, and a code of conduct for contributors.

3. Documentation Resources:

   • We'll point to our existing comprehensive documentation and expand upon it, ensuring new users can find detailed information on the platform's features, architecture, and more.

4. StreamETH-Platform Summary:

   • A brief overview of what the StreamETH platform is, its primary features, and the problems it aims to solve.

5. Goals of StreamETH:

   • Clearly define the objectives and long-term goals of StreamETH, to align the community's efforts and the development trajectory.

6. Setup Quickstart:

   • Provide a simplified setup guide, outlining necessary environment variables, system prerequisites, and a step-by-step guide to getting a local development instance up and running.

If anyone has any additional insights or feedback, please feel free to chime in!

from streameth-platform.