batteries folder: add a `README.md` explaining what batteries are!?

[jankoegel]

Feature description

• Guys, sorry if the question is stupid, but what is a battery in Alby? I have been looking at the code and reading references to "batteries" ... They look like integration points? is that it?

  (https://bitcoindesign.slack.com/archives/C02591ADXM2/p1675108228034929)

Describe the solution

• add a README.md in the batteries folder or a longer comment in batteries/index!?
• link to this from the general project README.

My stab at explaining what batteries are

Batteries are a directory in our code that collects JS files for integrating Alby on different services/social media platforms. E.g. the Twitter battery contains code that checks:

• is the current browser tab on Twitter (URL matching)?
• is there a lightning address in the Twitter profile description? see: https://github.com/getAlby/lightning-browser-extension/blob/d2e6e2d6d145d5904519f6[…]a7cfc499422c9/src/extension/content-script/batteries/Twitter.ts overview of batteries and their loading order (there's a fallback general one called Monetization that checks for our custom tags): https://github.com/getAlby/lightning-browser-extension/blob/master/src/extension/content-script/batteries/index.ts

Are you working on this?

No.

[priyavratamohan]

Hi, I'd like to work on this issue. Can you assign it to me?