Skip to content

Commit 6eeb6ae

Browse files
authored
docs(README): fix typos, improve formatting and clarity
1 parent 3e4f3e4 commit 6eeb6ae

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
> Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organisations.
66
7-
The SDK for Android and Java applications for [https://www.flagsmith.com/](https://www.flagsmith.com/).
7+
This SDK enables Android and Java applications to integrate with [Flagsmith](https://www.flagsmith.com/).
88

99
## Adding to your project
1010

@@ -20,21 +20,21 @@ If you encounter a bug or feature request we would like to hear about it. Before
2020

2121
## Get in touch
2222

23-
If you have any questions about our projects you can email <a href="mailto:[email protected]">[email protected]</a>.
23+
If you have any questions about our projects, email us at [[email protected]](mailto:[email protected]).
2424

2525
## Code Style formatting
26-
We are using Google Java Style for code formatting. To install one see instructions bellow
26+
27+
We use Google Java Style for code formatting. To install it, see the instructions below.
2728

2829
### VS Code
2930

30-
Install extension [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle)
31-
Use `java-google-style.xml` file in docs folder to set as Checkstyle configuration file.
31+
1. Install the [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle) extension.
32+
2. Use the `java-google-style.xml` file in the `docs` folder as the Checkstyle configuration file.
3233

3334
### IntelliJ
3435

3536
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`
36-
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.
37-
37+
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).
3838
## Useful links
3939

4040
[Website](https://www.flagsmith.com/)

0 commit comments

Comments
 (0)