[JUJU-4553] Update README.md to simplify and better align with docs

[tmihoc]

This is part of a larger initiative to update and streamline the READMEs of all the main projects associated in the Juju universe.

[tonyandrewmeyer]

Thanks! There's some nice bits in here, but also a lot where it's unclear why changes have been made, or where changes aren't all positive.

[benhoyt]

I agree with a lot of @tonyandrewmeyer's points here -- a can understand the desire to reduce the text and link it to more official places instead, but the big preformatted installation/usage example doesn't seem like an improvement.

@tmihoc I wonder if you could provide a bit more context on what we're aiming for here?

I wonder if it'd be good to brainstorm this with the 3 of us sitting together in Riga for 30-45 minutes?

[benhoyt]

Call me a grumpy old man :-), but I don't think these particular emojis add any value. The check mark has little to do with PyPI, the warning sign isn't really a warning, and medal != standard. I think we could just make these bullet points. Suggestion (also note slight tweaks):

Suggested change

	> ✔️ `ops` is ([`available on PyPI`](https://pypi.org/project/ops/)).
	>
	> ⚠️ The latest version of `ops` requires Python 3.8 or above.
	>
	> 🥇 While charms can be written in any language, `ops` defines the latest standard. All new charms are encouraged to use it.
	- `ops` is [available on PyPI](https://pypi.org/project/ops/).
	- The latest version of `ops` requires Python 3.8 or above.
	- While charms can be written in any language, `ops` defines the latest standard. All new charms are encouraged to use Python with `ops`.

[tmihoc]

I'll drop the emojis. I'll also try to move the third bullet in the introduction, as it seems to fit better there. (And some of the content there seems unnecessary.)

[tonyandrewmeyer]

Feel free to call me a grumpy old man too 😂, but I agree about the emojis - we still have the right-hand-pointing one in the table at the top. I'm not sure why that row gets/needs an emoji?

I don't feel super strongly about it (and in all seriousness, maybe I am showing my age) so if it has value then ignore this comment.

[tmihoc]

we still have the right-hand-pointing one in the table at the top

I wanted the table to act like a map to the Juju universe. I'm using it for the Juju and Charmcraft READMEs too. The right-hand-pointing emoji is supposed to be the "You are here" mark. PS I'm hoping some day we can replace it with a nice visual to the same effect -- ideally a visual with clickable links, just like in the table.

[benhoyt]

Suggested change

	...
	import ops.testing
	...
	import ops.testing

[tmihoc]

I used the dots to indicate a partial quote. Happy to drop the first set though.

[benhoyt]

I really like this now, thanks! It's good to have the test example, and I think linking to the setup/cleanup works much better than inlining it.

I've left a suggestion for the charm/directory name (I would like to improve this), and a few other very minor comments (take them or leave them).

I'll also get @tonyandrewmeyer's feedback on the latest iteration.

[benhoyt]

Same comment here about the link being a mouthful, and probably not needing the full tree. Suggestion:

Suggested change

	> See [Charm SDK | Set up your development environment automatically > Clean up](https://juju.is/docs/sdk/dev-setup#heading--automatic-set-up-an-ubuntu-charm-dev-vm-with-multipass).
	> See [Charm SDK > Clean up](https://juju.is/docs/sdk/dev-setup#heading--automatic-set-up-an-ubuntu-charm-dev-vm-with-multipass).

[tmihoc]

Done.

[tonyandrewmeyer]

Suggested change

...

[tmihoc]

Done

[tonyandrewmeyer]

I really like this now, thanks! It's good to have the test example, and I think linking to the setup/cleanup works much better than inlining it.

I've left a suggestion for the charm/directory name (I would like to improve this), and a few other very minor comments (take them or leave them).

I like this too, thanks! I also left a few formatting nits, +1'd the charm name, and had some take-or-leave-them minor comments.

Other than the example charm name, the one thing that I feel needs to get resolved is the ops/__init__.py alignment. I'm happy if the syncing is removed, but if so then the PR should remove the line saying that they should stay in sync.

[benhoyt]

Excellent, thanks for seeing this through!

[benhoyt]

Merged -- thanks @tmihoc! Not related to this PR, but linting is broken right now due to Python 3.12 deprecations. Tony is going to fix that in a follow-up PR.