Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
garethj-msft committed Sep 4, 2020
1 parent 6ee3bdc commit 6c96284
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 6 deletions.
8 changes: 7 additions & 1 deletion CsdlToDiagram.sln
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ VisualStudioVersion = 16.0.30413.136
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CsdlToDiagram", "CsdlToDiagram\CsdlToDiagram.csproj", "{35979C97-3ECF-45B7-87D0-043B1AF1CDDA}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CsdlToPlant", "CsdlToPlant\CsdlToPlant.csproj", "{F30F8D61-4ACB-4973-91D1-A3F855BF78E7}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CsdlToPlant", "CsdlToPlant\CsdlToPlant.csproj", "{F30F8D61-4ACB-4973-91D1-A3F855BF78E7}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionItems", "SolutionItems", "{6D6ED9E6-A9B1-4B72-A85C-C27CBE7892C0}"
ProjectSection(SolutionItems) = preProject
License.txt = License.txt
README.md = README.md
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
# CsdlToDiagram
Simple T4-powered console app to generate Plant or Yuml diagram from an OData CSDL file.

## Generate a Yuml diagram to the console.
CsdlToDiagram.exe -y < csdlFile >
Simple T4-powered console app to generate a PlantUml diagram from an OData CSDL file.

## Generate a PlantUML diagram to the console.
CsdlToDiagram.exe -p < csdlFile >
```
CsdlToDiagram.exe <csdlFile>
```

## Library CsdlToPlant
.Net Standard 2.0 library to create PlantUML text from a CSDL file.
Available on nuget as CsdlDiagrams.Net.

Usage:
```cs
var csdlFile = "<somefilename>";
var csdl = File.ReadAllText(csdlFile);
var converter = new PlantConverter();
var plantUml = converter.EmitPlantDiagram(generator.csdl, csdlFilename);
```

0 comments on commit 6c96284

Please sign in to comment.