Skip to content

Commit 1a27210

Browse files
Update README.md
1 parent 9ed7d7c commit 1a27210

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Android Dev Notes
22

3-
The website of Android Dev Notes.
3+
Android Dev Notes Website.
44

55
Link: https://androiddevnotes.com
66

@@ -10,41 +10,41 @@ Explore the Android development resources and notes. Contribute to it and make i
1010

1111
## How can I add content?
1212

13-
As a contributor to the Android Dev Notes website, you can add content related to Android/Kotlin in different sections, including Apps, Libraries, Tools, Tutorials, and Insights. Here are some guidelines to help you add content to the website:
13+
As a contributor to website of Android Dev Notes, you can add content related to Android/Kotlin in different sections, including Apps, Libraries, Tools, Tutorials, and Insights. Here are some guidelines to help you add content to the website:
1414

1515
Explore the website and see which section you can add content to. You are free to create new directories or files inside the sections to better organize content.
1616

1717
Take a look at `.mdx` files on GitHub in 'docs' directory. You can use the same format to add content to the website for the sections.
1818

1919
### Apps section
2020

21-
In the Apps section, you can add open source apps that you have found useful and think others will find useful too.
21+
In Apps section, you can add open source apps that you have found useful and think others will find useful too.
2222

2323
Example: Found an okay app with modern architecture and want to share it with others? Add it to the Apps section.
2424

2525
Format: The format for title is flexible. However, usually it is: `App Name - Short intro`. For example, `Palov - A Recipe App in Jetpack Compose`.
2626

2727
### Libraries section
2828

29-
In the Libraries section, you can add libraries that you have found useful and think others will find useful too.
29+
In Libraries section, you can add libraries that you have found useful and think others will find useful too.
3030

3131
Example: Found a new library for image processing and want to share it with others? Add it to the Libraries section.
3232

3333
### Tools section
3434

35-
In the Tools section, you can add tools that you have found useful and think others will find useful too.
35+
In Tools section, you can add tools that you have found useful and think others will find useful too.
3636

3737
Example: Found a tool that can boost productivity in Android Studio and want to share it with others? Add it to the Tools section.
3838

3939
### Tutorials section
4040

41-
In the Tutorials section, you can add tutorials that you have found useful or write your own tutorials that you think others will find useful too.
41+
In Tutorials section, you can add tutorials that you have found useful or write your own tutorials that you think others will find useful too.
4242

4343
Example: Found a tutorial that is simply interesting and want to share it with others? Add it to the Tutorials section.
4444

4545
### Insights section
4646

47-
In the Insights section, you can add any other useful information related to Android, such as website links, discussions, tips and tricks, or news about Android releases or deprecations.
47+
In Insights section, you can add any other useful information related to Android, such as website links, discussions, tips and tricks, or news about Android releases or deprecations.
4848

4949
Example: Found out something's going to be released soon or getting deprecated about Android and want to share it with others? Add it to the Insights section.
5050

@@ -59,7 +59,7 @@ Check out the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information on ho
5959
### Clone the repository
6060

6161
```bash
62-
git clone https://github.com/androiddevnotes/android-dev-notes-website
62+
git clone https://github.com/androiddevnotes/android-dev-notes-website.git
6363
```
6464

6565
### cd into the directory
@@ -80,12 +80,12 @@ npm install
8080
npm start
8181
```
8282

83-
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
83+
This particular command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
8484

8585
Website is running at http://localhost:3000/
8686

8787
Before contributing, you can optionally run the website locally to see if your changes look good and then create a pull request.
8888

8989
## Contributing
9090

91-
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
91+
Read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us.

0 commit comments

Comments
 (0)