docs: Add detailed README for NewsBit project#1
Open
rezwanahammad wants to merge 1 commit intomainfrom
Open
Conversation
This commit introduces a comprehensive README.md file for the NewsBit Android application. The README includes: - A project title and brief description. - A list of key features, such as user authentication (Firebase) and categorized news browsing. - An overview of the tech stack used (Java, Android SDK, Retrofit, Glide, Firebase Auth). - Setup instructions for cloning, configuring the newsapi.org API key (including a recommendation for secure storage), and setting up Firebase. - Placeholder section for future screenshots. - A note on contributions. The existing hardcoded API key is mentioned for evaluation purposes, with a strong recommendation to replace it and use secure practices for API key management.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit introduces a comprehensive README.md file for the NewsBit Android application.
The README includes:
The existing hardcoded API key is mentioned for evaluation purposes, with a strong recommendation to replace it and use secure practices for API key management.