Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-1190: Updated readme to fit new template #31

Merged
merged 2 commits into from
Oct 20, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# Ibexa AdminUI assets
# Ibexa Admin UI assets

This package is part of [Ibexa DXP](https://ibexa.co).

To use this package, [install Ibexa DXP](https://doc.ibexa.co/en/latest/install/).

This package contains assets for Back Office interface.

## Installing dependencies
dew326 marked this conversation as resolved.
Show resolved Hide resolved

1. `npm install`
2. `npm run prepare-release`

## Preparing a tag for release
dew326 marked this conversation as resolved.
Show resolved Hide resolved
## Preparing tag for release

To prepare a tag for release you have to run the following command from the root directory of the bundle:

Expand All @@ -14,15 +20,17 @@ sh bin/prepare_release.sh -v 1.0.0 -b master
```

Options:
1. -v : tag that will be released
1. -b : branch which will be used to create the tag
1. -v : tag to be released
1. -b : branch used to create the tag

If you are tagging for eZPlatform 2.5.x LTS you should use the 4.x branch.

## COPYRIGHT

Copyright (C) 1999-2021 Ibexa AS (formerly eZ Systems AS). All rights reserved.

## LICENSE

This source code is available separately under the following licenses:

A - Ibexa Business Use License Agreement (Ibexa BUL),
Expand Down