From ac67671297ff5cf38ab31bd138dcb6115616e6f6 Mon Sep 17 00:00:00 2001 From: Jan Max Meyer Date: Fri, 3 Mar 2023 00:10:45 +0100 Subject: [PATCH] Updating README --- LICENSE | 4 +--- README.md | 33 ++++++++++++++++++++++++--------- setup.cfg | 1 + 3 files changed, 26 insertions(+), 12 deletions(-) diff --git a/LICENSE b/LICENSE index 6b98719..c74c54d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,4 @@ -MIT License - -Copyright (c) 2021 Andreas H. Kelch +Copyright © 2023 by Andreas H. Kelch, Mausbrand Informationssysteme GmbH. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ec5fe64..69045b4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ -# ViUR-cli - -Command-line interface for ViUR application development maintenance. +
+ A hexagonal logo of the viur-cli +

viur-cli

+ + Badge showing current PyPI version + + + Badge displaying the license + +
+ Command-line interface for ViUR framework project maintenance. +
## Usage -viur-cli allows for control, maintain and develop a ViUR project from one central location by using the `viur` command +`viur-cli` allows to control, maintain and develop a ViUR project from one central location by using the `viur` command. + ```sh $ viur --help $ viur init @@ -19,7 +29,7 @@ $ viur env ## Installation -To use viur-cli in your ViUR projects, use [pipenv](https://pypi.org/project/pipenv/). +To use `viur-cli` in your ViUR projects, install the [PyPI package `viur-cli`](https://pypi.org/project/pipenv/). ```bash $ pipenv install --dev viur-cli @@ -27,7 +37,8 @@ $ pipenv install --dev viur-cli ## Packaged scripts -In order to use some of the packaged scripts, it is possible to simply run them from the environment that you installed viur-cli into. So if you are using a pipenv, then the scripts will be available in the shell just like you would run viur-cli by calling viur as well. +In order to use the packaged scripts, it is possible to simply run them from the environment that you installed viur-cli into. +So if you are using a pipenv, then the scripts will be available in the shell just like you would run viur-cli by calling viur as well. A handy script that has to be started this way is viur-2to3, which will automatically crawl through a project folder and detect deprecated syntax. It is not only useful for porting viur2 projects to viur3, but also when there are deprecations or breaking changes in viur3! @@ -41,7 +52,7 @@ This will dry-run the script in the current directory and not make any changes, ## Development -If you want to hack viur-cli, clone viur-cli next to your viur project folder. +If you want to hack `viur-cli`, clone this repository next to the folder of your ViUR project. ```sh $ git clone git@github.com:viur-framework/viur-cli.git @@ -50,7 +61,7 @@ viur-cli your-project ``` -Then, add it to your project this way +Then, add it to your project as an editable dependency using ```sh $ cd your-project @@ -69,4 +80,8 @@ viur-cli depends on ## License -Distributed under the MIT License. See `LICENSE` for more information. +Copyright © 2023 by Mausbrand Informationssysteme GmbH.
+Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH. + +This project is free software under the MIT license.
+Please see the LICENSE file for details. diff --git a/setup.cfg b/setup.cfg index eca57f5..0db87b3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -12,6 +12,7 @@ project_urls = classifiers = Programming Language :: Python :: 3 Operating System :: OS Independent + License :: OSI Approved :: MIT [options] package_dir =