From 72c5e9b850159c21dfc2f597077a205c5ab90d66 Mon Sep 17 00:00:00 2001 From: Philip Gichuhi Date: Tue, 21 Jun 2022 16:30:31 +0300 Subject: [PATCH] Update README --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5cd7cec..f75ca2a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,24 @@ -# Project +# Kiota Abstractions Library for PHP -> This repo has been populated by an initial template to help get you started. Please -> make sure to update the content to build a great experience for community-building. +[![Build Status](https://travis-ci.org/microsoft/kiota-abstractions-php.svg?branch=main)](https://travis-ci.org/microsoft/kiota-abstractions-php) +[![Latest Stable Version](https://poser.pugx.org/microsoft/kiota-abstractions/version)](https://packagist.org/packages/microsoft/kiota-abstractions) -As the maintainer of this project, please make a few updates: +The Kiota abstractions Library for PHP is the PHP library defining the basic constructs Kiota projects need once an SDK has been generated from an OpenAPI definition. -- Improving this README.MD file to provide a great experience -- Updating SUPPORT.MD with content about this project's support experience -- Understanding the security reporting process in SECURITY.MD -- Remove this section from the README +A [Kiota](https://github.com/microsoft/kiota) generated project will need a reference to the abstraction package to build and run. + +Read more about Kiota [here](https://github.com/microsoft/kiota/blob/main/README.md). + +## Using the Abstractions Library +run `composer require microsoft/kiota-abstractions` or add the following to your `composer.json` file: + +```Shell +{ + "require": { + "microsoft/kiota-abstractions": "^0.1.0" + } +} +``` ## Contributing @@ -26,8 +36,8 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio ## Trademarks -This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft -trademarks or logos is subject to and must follow +This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft +trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.