Readme Feedback

[YajJackson]

Topic and scope of discussion

Documentation

Motivation

This will help make the project more accessible to new users

Additional context

This is a mostly subjective post.

I would love to use this project, but have found it difficult to find some useful information in the readme. Below are some suggestions/ requests for information to be added to the readme.

• An Installation section would be helpful. Is this package intended to be installed globally or as a dev-dependency? A simple npm i -g semantic-release-expo or npm i semantic-release-expo snippet would save people time.
• The Usage section includes some kind of configuration file, but doesn't mention any associated name. What is this file called?
• A Getting started section would be very awesome. Something that outlines the basic steps for incrementing versions/ building. Example:
  1. Install npm i semantic-release-expo
  2. Update .exporeleaserc (or whatever the config file is named) with versioning preferences:
  3. expo:build
  4. 💰

{
    "prepare": [
        {
            "versions": {
                "version": "${next.raw}",
                "android": "${code}",
                "ios": "${next.raw}"
            }
        }
    ]
} 

*edit premature submit 😓

[byCedric]

Hi @YajJackson! Thanks for your feedback and help make this library way more awesome! ♥️

Right now I'm in Thailand for another 1.5 weeks, when I get back I'll try to update the readme based on your feedback here 😁

But, if you are stuck, here are the answers on your 3 points 😁

1. You can install it globally and locally. It depends on how you use semantic release actually. So if you install semantic release locally, you have to install this plugin locally too. I would personally recommend install it locally, but if you use CI/CD you can create a docker image with this globally installed. Here is an example for the docker image we use at Peakfijn.

2. I'd recommend checking out the semantic release readme for the appropriate configuration. Here you can read about the configuration methods. If you need more help, let me know 😁

3. By default, you don't need any configuration. It has some sensible defaults which you can overwrite if you want. You can check out the getting started guide of semantic release itself to get you started a bit more. At 2.iii, there is some additional information about configuring the release steps. There you should be able to see how you need to configure this plugin.

Again, thanks for your feedback! ♥️ If you need more help, let me know. When I get back I'll take a look at improving the readme 😁

[YajJackson]

@byCedric No problem, looking forward to incorporating this tool into my team's release pipeline. Safe travels, and thank you for the prompt response!