search

moufette-tools / moufette

🦨 Moufette is developer-friendly, open-source set of tools to collect users feedback. Find us on Twitter @MoufetteHQ
MIT License
323 stars 20 forks source link

Explain what this code does in ReadMe #1

Open rimutaka opened 4 years ago

rimutaka commented 4 years ago

The project description at the top sounds interesting, but how does it work?

A few lines describing the product, how it works and what the benefit of using it at the top of readme.md would help. It would be good to have an example and a few screenshots.

jamalx31 commented 4 years ago

@rimutaka I have updated the readme, lmk what you think. 10x

rimutaka commented 4 years ago

Jamal, it's getting there.

Moufette is an open-soruce [????], built for developers. - an open source what? An app? A library? What does it do exactly?

You need to reduce it to a very simple definition that speaks to your target user.

Here is a made-up example: MF is an embedable JS widget with such and such back-end to collect user feedback with screenshots. Make it easeir for your users to help you build a better app.

A few screenshots of what the UI may look like will help.

Then you can go into all the technical details on how to install and use it.

jamalx31 commented 4 years ago

@rimutaka thank you so much. really appreciate the feedback. I've updated the description and added screenshots.

rimutaka commented 4 years ago

Nice :) I'd drop the badger illustration and add a sample embed snippet.

Ping me when you add more contents for another round of reviews. I'm interested to see how your docs progress.