README should be updated with mamba flags

[GabrielDougherty]

The README still uses the old flags before mamba support was added.

[yibum]

The README update should come with new release
I have the similar issue running example #32, my fix for that is to use local_repository.

[GabrielDougherty]

The README update should come with new release

I don't understand this suggestion. Can you please explain what you mean?

[yibum]

The README update should come with new release

I don't understand this suggestion. Can you please explain what you mean?

The current mamba support is only in main, but not in release yet.
In README, the Quickstart part is using release version which is not supporting new features (mamba support). Maybe either create a release and update the README with mamba support, or add a section to emphasize that mamba support is only available in main branch now.

[spietras]

On one hand, it would be great to update the docs (both README and in docs) after each change in the main branch. Then they are always up to date. On the other hand, users should use the release version and README should provide info about using the latest release version. In this case, we are not up to date with all the changes in the main branch.

Not sure what's the best practice here.

[yibum]

Can we add a section called "Newly added features available in main branch" which list added features in main but not yet in release.
In each release, remove these features from the section.

[spietras]

Yeah, I think it's a good idea

[GabrielDougherty]

Not sure what's the best practice here.

@yibum's suggestion makes sense. I have a slightly different idea. I suggest that we do a new release every time the README changes. I propose the following next steps:

• Update the README to reflect the current usage with mamba
• Create a release
• Next time a feature is implemented, update the README and make a new release

Here is a Stack Overflow article on this idea: https://stackoverflow.com/questions/26334169/do-i-have-to-update-project-version-when-only-readme-has-changed-on-github

[spietras]

I suggest that we do a new release every time the README changes.

Not sure about that as making new releases is kinda inconvenient as I need to manually zip the files and update the usages with the hash of the zip file. If it would be just clicking a button then it would be fine, but unfortunately, it's more than that. It can be automated but this is also hard to do.

But maybe there is something to it, so let's try it in practice.