diff --git a/README.md b/README.md index 884791cd76edc182693e792aea7845c1711f2545..345e1b2624638e39efab6cac6ce7bd0aec360f48 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ _:pushpin: Note:_ we recommend to use [Yarn] instead of NPM for package manageme ### Install -Hacking the Cozy LyonLivingLabEnergy app requires you to [setup a dev environment][setup]. +Hacking the Cozy Ecolyo app requires you to [setup a dev environment][setup]. You can then clone the app repository and install dependencies: @@ -73,23 +73,12 @@ Whenever your app needs to use a given `doctype`, you should: ### Open a Pull-Request -If you want to work on LyonLivingLabEnergy and submit code modifications, feel free to open pull-requests! See the [contributing guide][contribute] for more information about how to properly open pull-requests. +If you want to work on Ecolyo and submit code modifications, feel free to open pull-requests! See the [contributing guide][contribute] for more information about how to properly open pull-requests. -### Commits and releases - -This app uses the [standard-version module][standard-version] to release version automatically. +### Commits You must follow these rules to write your commit messages : [Conventional Commits Specification][conventional-commits] -To make a new release, bump the version in the package.json and create a Git tag, use the following command depending on the needs : - -* `yarn release --first-release` to make the first release (will not bump the version). -* `yarn release` to automatically bump the version based on the last commit types. -* `yarn release --prerelease alpha` to make a pre-release suffixed with 'alpha'. -* `yarn release --release-as patch` to force bump the patch number in the version tag. -* `yarn release --release-as minor` to force bump the minor number in the version tag. -* `yarn release --release-as major` to force bump the major number in the version tag. - ## Community @@ -115,7 +104,7 @@ As a _developer_, you must [configure the transifex client][tx-client], and clai ### Maintainer -The lead maintainer for LyonLivingLabEnergy is [hsubtil](https://forge.grandlyon.com/ext.sopra.husubtil), send him/her a :beers: to say hello! +The lead maintainer for Ecolyo is [hsubtil](https://forge.grandlyon.com/ext.sopra.husubtil), send him/her a :beers: to say hello! ### Get in touch @@ -130,7 +119,7 @@ You can reach the Cozy Community by: ## License -LyonLivingLabEnergy is developed by "La métropole de Lyon" and distributed under the [AGPL v3 license][agpl-3.0]. +Ecolyo is developed by "La métropole de Lyon" and distributed under the [AGPL v3 license][agpl-3.0].