Skip to content

Commit

Permalink
Prepare first release (#37)
Browse files Browse the repository at this point in the history
  • Loading branch information
akondas committed Apr 22, 2020
1 parent fe2d53d commit fbe8ef4
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 8 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/.github export-ignore
/docs export-ignore
/tests export-ignore
/examples export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2020-04-22
### First release :tada:
- working structurizr client written in PHP
- most of the most important functions implemented
- tested on structures from real production projects
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 structurizr-php

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Structurizr for PHP

[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.3-8892BF.svg)](https://php.net/)
[![Latest Stable Version](https://poser.pugx.org/structurizr-php/structurizr-php/version)](https://packagist.org/packages/structurizr-php/structurizr-php)
![](https://github.com/structurizr-php/structurizr-php/workflows/Tests/badge.svg?branch=master)
[![Total Downloads](https://poser.pugx.org/structurizr-php/structurizr-php/downloads)](https://packagist.org/packages/structurizr-php/structurizr-php)
![License](https://img.shields.io/github/license/structurizr-php/structurizr-php)

This repository is a port of [Structirizr for Java](https://github.com/structurizr/java).
All credits for creating [C4](https://c4model.com/) goes of course to [Simon Brown](https://github.com/simonbrowndotje)
this library is nothing more that simple port of the code that already exists in other language.

# How to Use

> Careful, this port is still under heavy development, API might change over time, it's not recommended for production
> usage yet.
### Installation

> Because package does not have yet stable release you might need to use @dev stability flag to not get
> into minimum stability composer error.
```
composer require structurizr-php/structurizr-php:@dev --dev
composer require structurizr-php/structurizr-php
```

### A quick example
Expand Down Expand Up @@ -58,6 +58,7 @@ $client = new Client(
new UrlMap('https://api.structurizr.com'),
new Psr18Client(),
new SymfonyRequestFactory(),
new Logger('structurizr', [new StreamHandler('php://stdout')])
);
$client->put($workspace);
```
Expand Down Expand Up @@ -92,4 +93,4 @@ The view can then be exported to be visualised in a number of different ways; e.
![Components](/docs/images/big_bank_plc/Components.png)
![Dynamic](/docs/images/big_bank_plc/Dynamic.png)
![Development Deployment](/docs/images/big_bank_plc/DevelopmentDeployment.png)
![Live Deployment](/docs/images/big_bank_plc/LiveDeployment.png)
![Live Deployment](/docs/images/big_bank_plc/LiveDeployment.png)

0 comments on commit fbe8ef4

Please sign in to comment.