Improve README (#722)

[barrybecker4]

Some fixes to the README based on https://docs.google.com/document/d/1Ep7Xucqt-Y6OXiCO_LNOTwUep_DMgVfxy6V1Fg5AwzM/edit.

Also updated libx11 in the ui docker file to avoid an error.

[ottomorac]

Thanks @barrybecker4 for the contribution.

@x1m3 Please review the contribution. Barry has been interacting with me and Ram in one our client conversations. He has confirmed that the PR is now ready for review.

[guillermovahi]

@barrybecker4 can you please provide the tutorial mentioned on this doc (https://docs.google.com/document/d/1Ep7Xucqt-Y6OXiCO_LNOTwUep_DMgVfxy6V1Fg5AwzM/edit) where it should be explained how to integrate PrivadoID SDK into a react app where a graduate student can apply for a job on the platform?
Thanks in advance

[ottomorac]

@barrybecker4 can you please provide the tutorial mentioned on this doc (https://docs.google.com/document/d/1Ep7Xucqt-Y6OXiCO_LNOTwUep_DMgVfxy6V1Fg5AwzM/edit) where it should be explained how to integrate PrivadoID SDK into a react app where a graduate student can apply for a job on the platform? Thanks in advance

Hi @guillermovahi . Not sure what you are asking. The google doc for the tutorial is already public. I gave you a follow on X if you want to chat via DM in more detail.

[barrybecker4]

@guillermovahi , I added that link in the README, but that doc contains nearly duplicate setup instructions. It would be nice to consolidate all the slightly different setup instructions into one source of truth. Also it refers to integration into a react app as a follow on tutorial, but never provides a link to it.
This is the commit that adds the link and does some other clean up.

[x1m3]

We are about to do a new release and there will be significant changes in the README file. We will consider your requests and try to include it.

@barrybecker4 @guillermovahi

[x1m3]

Hi @barrybecker4 @guillermovahi

New v3.0.0 release includes many changes and i guess your suggestions are covered there.

Please, for contributions follow guidelines in contrib.md. We usually cannot accept direct merges to main branch. The desired branch is develop.

Any suggestion and contrib is always welcome

[barrybecker4]

@x1m3 @guillermovahi I'm not sure if any of my changes were actually incorporated. For example

• There are no additional instructions on how to use or configure ngrok or localtunnel.
• The license link at the bottom is still broken.
• Adding additional University credential demo link

I will give the new instructions a try and see if they are any easier, but it would be nice if some of my suggestions could be incorporated.

[amonsosanz]

Hi @barrybecker4.

There are no additional instructions on how to use or configure ngrok or localtunnel.

We do mention "use a tool like Localtunnel for testing purposes" in the readme. I don't think our readme should include a deeper level of detail. You can go to the documentation of these tools to get the details on how to use them. Also, these third-party tools, if ever used, should be used only in the testing phase, never in production. I fear that giving them more relevance in the readme could mislead some inexperienced users. But it's my opinion, you might be right. Also, mention that we have this guide in our FAQ. Maybe we can link it emphasizing that it should be only used for testing? By the way, I have just opened a PR to update that guide that became obsolete after this release.

The license link at the bottom is still broken.

This was fixed here. You can see the fix in the develop branch.

Adding additional University credential demo link

I guess we can add that link.

[barrybecker4]

Thanks. I will give the new instructions another try this weekend.