[DOCS] Improve the Readme to explain how to create the components

[dheysonalves]

Expected Behavior

It should explain how to create the components

Actual Behavior

It has no good explanation.

[ampsteric]

can you mention the steps and I can convert them into a nice README? I would love to work on this. assign it to me please

[dheysonalves]

Hey @ampsteric, thanks for the reply, sure!

We used to create four files for each component, based on the folder component name: Ex: Button

• index.txs
• styles.ts
• index.stories.tsx
• index.test.ts

You could structure a new section on the readme with a title: How to Create The Components? We would love to see a kind of table with 2 columns with:

• File Name
• File Description

And the rows based on each file. Which I describe on the top of this comment.

That`s it, we are open to any suggestions!

Thanks again for the reply :)

[dheysonalves]

Hey @ampsteric, are you still gonna work on this issue?

[ampsteric]

@Dheyson do I need to provide the description of all the files in the table?

[dheysonalves]

Yes, @ampsteric would be great. You could link each with a component example in the repository. To show the file structure. There is a folder called generators, that is for generate template files and shows the main file structure. But, if you have any suggestion, we are open.