Confusing docs language

[BenJackGill]

At the top of the front page for this repo it says:

Sync packages when deploying monorepos with firebase using yarn or bolt workspaces

Have you ever have a problem when deploying npm package with monorepos inside firebase functions ? You are really lucky then! Skip this library!'

This suggests that firelink library does NOT work for npm wordspace monorepos.

But further down the page it says:

The only purpose is to copy mapped modules inside package.json before working with firebase CLI. This way when deploying application npm will install packages locally file:./.packages/database instead from global registry.

This suggests it DOES work for npm wordspace monorepos.

The language is conflicting. I original ignored this package because I thought it only worked with yarn or bolt. Then I came a few days later after I realised I was wrong, it does work for npm workspaces. And I think many others users have also been driven away by the confusion.

Suggestion 1) Add npm to the top line:

Sync packages when deploying monorepos with firebase using yarn or bolt or npm workspaces

Suggestion 2) Delete this line:

Have you ever have a problem when deploying npm package with monorepos inside firebase functions ? You are really lucky then! Skip this library!'

[Stradivario]

Hey @BenJackGill thank you very much for the feedback!

I was on vaccation last two weeks and this is why i answer so latetly. Probably tomorrow i will have time to introduce a PR with changes in README. There is a big refactoring coming along #69 and these changes will be reflected in the new version of the library also.

Again thanks for the feedback

Best Regards,
Kristiyan Tachev