Provide a good manual in the readme

BoltTranslate / labels

Bolt Labels extension - Translatable labels for Bolt

https://bolt.cm/

18 stars 12 forks source link

Provide a good manual in the readme #6

Closed ankedsgn closed 8 years ago

ankedsgn commented 9 years ago

The readme is pretty.. ehm... obscure. It only tells you what tag to use, the rest is probably something you should guess. I can image the following explanation:

What tag
What can you add in the config, if any?
When is the label added? (a: when the page is loaded)
What do you do next? (a: download the csv)
What should you do with the csv?
What errors can you expect and how to fix this easily

phpetra commented 8 years ago

I agree :(

In the official docs you mention this extension as helpful for a multilingual site, but I don't even know what I'm supposed to put in this csv, I apparently need to upload? What structure should it have? And how or where do I define the labels??

Can we maybe have a follow up on this?

ankedsgn commented 8 years ago

Hi @bobdenotter, could you appoint this issue and all other open issues to someone who can look into them? Thanks!

GwendolenLynch commented 8 years ago

Throw a penguin at him, @anketwokings :wink:

bobdenotter commented 8 years ago

:fire: :boom: :bomb: I'm going to do some light maintenance on this! :fire: :boom: :bomb: :fire: :boom: :bomb: :fire: :boom: :bomb:

bobdenotter commented 8 years ago

I made EVERYTHING different! Check the new readme:

https://github.com/bolt/labels/blob/master/README.md

ankedsgn commented 8 years ago

That deserves a penguin! thumbs up!

GwendolenLynch commented 8 years ago

:+1:

bobdenotter commented 8 years ago

Fixed by #7

phpetra commented 8 years ago

@bobdenotter Now that is very helpful! A big thumbs up from me too!