diff --git a/README.md b/README.md index 3e76a6ec..ba48788b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ > Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organisations. -The SDK for Android and Java applications for [https://www.flagsmith.com/](https://www.flagsmith.com/). +This SDK enables Android and Java applications to integrate with [Flagsmith](https://www.flagsmith.com/). ## Adding to your project @@ -20,21 +20,21 @@ If you encounter a bug or feature request we would like to hear about it. Before ## Get in touch -If you have any questions about our projects you can email support@flagsmith.com. +If you have any questions about our projects, email us at [support@flagsmith.com](mailto:support@flagsmith.com). ## Code Style formatting -We are using Google Java Style for code formatting. To install one see instructions bellow + +We use Google Java Style for code formatting. To install it, see the instructions below. ### VS Code -Install extension [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle) -Use `java-google-style.xml` file in docs folder to set as Checkstyle configuration file. +1. Install the [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle) extension. +2. Use the `java-google-style.xml` file in the `docs` folder as the Checkstyle configuration file. ### IntelliJ To add GoogleStyle formatting in IntelliJ go to `Preferences -> Editor - Code Style -> Java`. From Schema `Import Schema` and select file `docs/java-google-style.xml` -Once added, you now be able to Reformat Code using GoogleStyle, which can be triggered from the Code menu or with the Ctrl-Alt-L (by default) keyboard shortcut. - +Once added, you will be able to reformat code using GoogleStyle. This can be triggered from the Code menu or with the `Ctrl + Alt + L` shortcut (default). ## Useful links [Website](https://www.flagsmith.com/)