search

awslabs / cognito-at-edge

Serverless authentication solution to protect your website or Amplify application
Apache License 2.0
168 stars 54 forks source link

Readme updates #1

Closed jenirain closed 3 years ago

jenirain commented 3 years ago

Issue #, if available: N/A - this is in preparation for pushing this to open source and publishing to NPM.

Description of changes: Added some more precise links to the README.md for the Getting Help section Added link to apache license Reworded some bits of getting started In CONTRIBUTING.md - added section for testing code. this still needs details.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

jenirain commented 3 years ago

Just read in PublishingToNPM wiki page this: 

Your .npmignore should actually _exclude_ your original sources (obviously, your gitignore should not do this).

So, I will add an .npmignore file. (If this is wrong, someone on the team will help me understand how to do this properly.

I did not exclude our source file because I don't think we compile to a lib directory. (please advise)

jeandek commented 3 years ago

We don't need a .npmignore file, because the package.json explicitly specifies which files to include in the package (via the files key).

Also, your template files look different from what I can see in the docs. Not sure if it's purposeful. EDIT: Never mind, I found another page of docs that use the same syntax as you. Confusing, to say the least...

Other than that, looks good.

jenirain commented 3 years ago

Removed .npmignore.

Do you want me to recreate the templates in yaml? I'm more than happy to if you prefer that.

jeandek commented 3 years ago

Do you want me to recreate the templates in yaml? I'm more than happy to if you prefer that.

I don't think that's necessary. They all seem valid to me.