Missing Readme

[woodpig07]

What information are you looking for? User guide or development setup?

For now you can check https://github.com/Wiredcraft/jekyllpro-cms/blob/dev-client/api/README.md https://github.com/Wiredcraft/jekyllpro-cms/blob/dev-client/client/README.md

There will be more documentation coming after.

[paulvollmer]

"What information are you looking for?" - both, i'm new at the project...

i've found the api and client readme's but it's api or client specific and i want to read a short introduction about the project, about the architecture and the development (things like, go to the dev-clientbranch for latest development)...

thank you, paul

[Jamesford]

@paulvollmer Sorry I meant to talk with you about this today, but I forgot. 😓

We usually don't create issues with only a title, even for simple things like this. It's always beneficial to include some extra info to help whomever is assigned to the issue. Or anything extra, such as a question, just to get the conversation moving.

From the playbook

Write proper issues & comments; we’ve written about it before. Always give context and clear next steps to your messages.

And below that rule in the playbook...

Always have a README; we always add a README.md file at the root of our repositories to explain what it is and potentially give further instructions (installation, deployment, todo list…).

Haha! 😆

So, yes let's get a readme setup, and let's also remember to write proper issues in the future.

For now we can add the readme in the root directory and include the information to check the readme's in the other directories. And then we can add to the main readme as necessary.

[woodpig07]

added