I've had some feedback with regards to our README file. The README file does not explain well enough why someone should use Bastion. In particular, what are its strengths and why would someone go through the entire process of getting familiar with its API just to use it for their project?
We need someone who is good with words to work their magic and improve the README file so that it is attractive to whoever comes into the repository. Remember that the README file's content is the first thing that people will see when they go to http://bastion.rocks (for now), so it's important to not bore them right-off-the-bat.
Something else to keep in mind: I don't want Bastion to directly compete with other great projects in the open-source community since that is not the point and their contributions are always appreciated. We shouldn't mention any other open-source projects negatively; instead, the README file should focus on the typical use-cases why someone would choose Bastion over anything else which is available.
Note: The actual README.md file in the repository root is auto-generated. A fix for this issue needs to be done in src/docs/README.md.
I've had some feedback with regards to our README file. The README file does not explain well enough why someone should use Bastion. In particular, what are its strengths and why would someone go through the entire process of getting familiar with its API just to use it for their project?
We need someone who is good with words to work their magic and improve the README file so that it is attractive to whoever comes into the repository. Remember that the README file's content is the first thing that people will see when they go to http://bastion.rocks (for now), so it's important to not bore them right-off-the-bat.
Something else to keep in mind: I don't want Bastion to directly compete with other great projects in the open-source community since that is not the point and their contributions are always appreciated. We shouldn't mention any other open-source projects negatively; instead, the README file should focus on the typical use-cases why someone would choose Bastion over anything else which is available.
Note: The actual
README.mdfile in the repository root is auto-generated. A fix for this issue needs to be done insrc/docs/README.md.