Skip to content

Conversation

@catrawalkar
Copy link
Contributor

Description

Just getting started, so just added few documentation lines.

README.md Outdated
Comment on lines 95 to 96
1. Fork this repository using by clicking _Fork_ button at the top
1. Clone your own version on repository by using `git clone https://github.com/<username>/reactfire.git` (replace the repo url with your own version's url)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can simplify the first two down to:

1. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this repository (or a [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo#propose-changes-to-someone-elses-project))

Which will look like this:

  1. Clone this repository (or clone a fork)

README.md Outdated
1. At the project root, run `yarn install`
1. Fork this repository using by clicking _Fork_ button at the top
1. Clone your own version on repository by using `git clone https://github.com/<username>/reactfire.git` (replace the repo url with your own version's url)
1. At the project root, install all modules by running `yarn install` or `npm install`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove npm install. This project uses a yarn workspace so npm install likely won't work.

@jhuleatt
Copy link
Collaborator

Thanks for the PR, @catrawalkar! I've added a few comments, but once you update those things I'll merge this.

@catrawalkar
Copy link
Contributor Author

@jhuleatt done :)

@jhuleatt jhuleatt merged commit fa4e20e into FirebaseExtended:master Nov 1, 2019
@catrawalkar catrawalkar deleted the pr/README.md branch November 21, 2019 08:20
@FirebaseExtended FirebaseExtended locked and limited conversation to collaborators Dec 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants