Skip to content

Commit 7523abd

Browse files
committed
📝 update docs for new release
1 parent 393ef93 commit 7523abd

File tree

4 files changed

+36
-95
lines changed

4 files changed

+36
-95
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ NuGet\Install-Package Doroudi.ConsoleR
2222
- WriteLine
2323
- Password
2424
- Alert
25+
- Table
2526

2627

2728
#### How To Use
@@ -63,6 +64,18 @@ for (int i = 0; i < selectedItems.Length; i++) {
6364
Console.WriteLine(plugin.Option, (ConsoleColor)i);
6465
}
6566

67+
// Table
68+
Person[] people = [
69+
new Person("Saeid",30, "Tehran"),
70+
new Person("Saman", 25, "Marand"),
71+
new Person("Alice", 35, "Zurich"),
72+
new Person("Alex", 40, "Turin")
73+
];
74+
75+
Console.Table(people);
76+
77+
78+
record Person(string Name,int Age, string City);
6679
```
6780

6881
#### Output

src/ConsoleR/ConsoleR.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
1414
</PropertyGroup>
1515
<PropertyGroup>
16-
<Version>0.1.4</Version>
16+
<Version>0.2.0</Version>
1717
<PackageId>Doroudi.ConsoleR</PackageId>
1818
<Authors>Saeid Doroudi</Authors>
1919
<Description>ConsoleR is set of utilities to make awesome console apps in .Net</Description>

src/ConsoleR/Readme.md

Lines changed: 13 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,17 @@
22

33
ConsoleR is set of utilities to make awesome console apps in .Net
44

5-
## Installation
6-
7-
```bash
8-
dotnet add package Doroudi.ConsoleR
9-
```
10-
11-
or
12-
13-
```bash
14-
NuGet\Install-Package Doroudi.ConsoleR
15-
```
16-
17-
### Features
5+
## Features
186

197
- Menu
208
- CheckBox
219
- AsciiArt
2210
- WriteLine
2311
- Password
2412
- Alert
13+
- Table
2514

26-
27-
#### How To Use
15+
### How To Use
2816

2917
```csharp
3018
using ConsoleR;
@@ -63,78 +51,20 @@ for (int i = 0; i < selectedItems.Length; i++) {
6351
Console.WriteLine(plugin.Option, (ConsoleColor)i);
6452
}
6553

66-
```
67-
68-
#### Output
69-
70-
![ConsoleR](https://raw.githubusercontent.com/doroudi/ConsoleR/refs/heads/main/docs/ConsoleRBanner.png)
71-
# ConsoleR
72-
73-
ConsoleR is set of utilities to make awesome console apps in .Net
74-
75-
## Installation
76-
77-
```bash
78-
dotnet add package Doroudi.ConsoleR
79-
```
54+
// Table
55+
Person[] people = [
56+
new Person("Saeid",30, "Tehran"),
57+
new Person("Saman", 25, "Marand"),
58+
new Person("Alice", 35, "Zurich"),
59+
new Person("Alex", 40, "Turin")
60+
];
8061

81-
or
82-
83-
```bash
84-
NuGet\Install-Package Doroudi.ConsoleR
85-
```
86-
87-
### Features
88-
89-
- Menu
90-
- CheckBox
91-
- AsciiArt
92-
- WriteLine
93-
- Password
94-
- Alert
95-
96-
97-
#### How To Use
98-
99-
```csharp
100-
using ConsoleR;
101-
using Console = ConsoleR.Console;
62+
Console.Table(people);
10263

103-
// AsciiArt
104-
Console.AsciiArt("ConsoleR", ConsoleColor.Yellow);
105-
Console.ReadLine("Press enter to continue");
106-
107-
// WriteLine utilities
108-
Console.Info("Progress started");
109-
Console.Warning("It seems there is issue in the system");
110-
Console.Error("Process failed :(");
111-
Console.Info("Retrying...");
112-
Console.Success("Progress Succeed", showIcon: true);
113-
Console.WriteLine("Wait it is not completed yet", ConsoleColor.Magenta);
114-
115-
// Get Masked Password
116-
var password = Console.Password("Enter your password:");
117-
118-
// Alert
119-
Console.Alert($"your password is: {password}", "Password", ConsoleMessageType.Info);
120-
121-
// Console Menu
122-
string[] frontEndFrameworks = ["Blazor", "Angular", "Vue", "React", "VanillaJs"];
123-
var selectedItem = Console.Menu("Please Select One beloved frontend framework", frontEndFrameworks).Select();
124-
Console.Success("Your choice is: \n\n");
125-
Console.AsciiArt(frontEndFrameworks[selectedItem], ConsoleColor.Yellow);
126-
127-
128-
// Checkbox
129-
string[] plugins = ["Typescript", "Linter", "Nuxt", "Vite"];
130-
var selectedItems = Console.Checkbox("Select feature that you want to install:", plugins).Select();
131-
for (int i = 0; i < selectedItems.Length; i++) {
132-
var plugin = selectedItems[i];
133-
Console.WriteLine(plugin.Option, (ConsoleColor)i);
134-
}
13564

65+
record Person(string Name,int Age, string City);
13666
```
13767

138-
#### Output
68+
### Output
13969

14070
![ConsoleR](https://raw.githubusercontent.com/doroudi/ConsoleR/refs/heads/main/docs/ConsoleRBanner.png)

tests/ConsoleR.TestApp/Program.cs

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,6 @@
22
using Console = ConsoleR.Console;
33

44

5-
Person[] people = [
6-
new Person("Saeid Doroudi",30, "Tehran"),
7-
new Person("Saman", 25, "Marand"),
8-
new Person("Alice", 35, "Zurich"),
9-
new Person("Alireza", 40, "Tabriz")
10-
];
11-
12-
Console.Table(people);
13-
14-
return;
15-
165
string[] frontEndFrameworks = ["Blazor", "Angular", "Vue", "React", "VanillaJs"];
176
var selectedItem = Console.Menu("Please Select One beloved frontend framework", frontEndFrameworks).Select();
187
Console.AsciiArt(frontEndFrameworks[selectedItem], GetFrameworkColor(frontEndFrameworks[selectedItem]));
@@ -36,6 +25,15 @@
3625
Console.WriteLine(plugin.Option, (ConsoleColor)i);
3726
}
3827

28+
// Table
29+
Person[] people = [
30+
new Person("Saeid Doroudi",30, "Tehran"),
31+
new Person("Saman", 25, "Marand"),
32+
new Person("Alice", 35, "Zurich"),
33+
new Person("Alireza", 40, "Tabriz")
34+
];
35+
36+
Console.Table(people);
3937

4038
ConsoleColor GetFrameworkColor(string framework) {
4139
return framework switch {

0 commit comments

Comments
 (0)