Skip to content

Commit c55428b

Browse files
authored
Merge pull request #6 from ErenKrt/development
Updated documents
2 parents f13084b + 303117f commit c55428b

File tree

5 files changed

+34
-37
lines changed

5 files changed

+34
-37
lines changed

README.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,38 @@
33

44
A .NET client for [CycleTLS](https://github.com/Danny-Dasilva/CycleTLS).
55

6-
.NET 7.0 | You can build if you need another version of .net
7-
8-
6+
![GitHub Workflow](https://img.shields.io/github/actions/workflow/status/erenkrt/CycleTLS.NET/publish.yml)
7+
[![CycleTLS.NET](https://img.shields.io/nuget/dt/CycleTLS?label=NuGet%20CycleTLS)](https://www.nuget.org/packages/CycleTLS/)
8+
[![CycleTLS.NET.RestSharp](https://img.shields.io/nuget/dt/CycleTLS.RestSharp?label=NuGet%20CycleTLS.RestSharp)](https://www.nuget.org/packages/CycleTLS.RestSharp/)
9+
![GitHub tag](https://img.shields.io/github/v/tag/erenkrt/cycletls.net?label=Version)
910

11+
Supports .NET 8.0 (Build available for other .Net versions)
1012
## Installation
1113

12-
1. Download the latest release and import it into your project.
14+
### With Nuget
15+
1. In Visual Studio, right-click on your project's Solution Explorer and select 'Manage NuGet Packages'.
16+
2. Go to the 'Browse' tab, search for `CycleTLS` and `CycleTLS.RestSharp`.
17+
3. Click 'Install' for each package.
18+
4. Accept the prompts to complete installation.
19+
20+
Or, via Package Manager Console:
21+
```bash
22+
Install-Package CycleTLS
23+
```
1324

14-
2. Next, you'll need to download the executable for [CycleTLS](https://www.npmjs.com/package/cycletls?activeTab=code). Install CycleTLS using NPM by following these steps:
25+
### Manual Installation
1526

16-
- Open your terminal or command prompt.
17-
- Navigate to your project directory using the `cd` command.
18-
- Run the following command to install CycleTLS: `npm install cycletls`
27+
1. Download the latest release of CycleTLS.NET's and import it into your project.
28+
2. Install CycleTLS using NPM:
29+
- Open a terminal/command prompt.
30+
- Navigate to your project directory (`cd your_project_path`).
31+
- Run `npm install cycletls`.
1932

20-
3. Once CycleTLS is installed, locate the executable file in the installation folder.
33+
Locate the CycleTLS executable in the installation folder after installation.
2134

22-
By following these steps, you'll have CycleTLS installed and ready to use in your project.
2335
## Usage
2436

25-
#### Server
37+
### Server
2638

2739
```csharp
2840
using CycleTLS;
@@ -57,17 +69,23 @@ RestClient restClient = new(new RestClientOptions()
5769
BaseUrl = new Uri("https://example.org"),
5870
});
5971

72+
restClient.AddDefaultHeader("ja3", "ja3 value"); // Set JA3 all requests
73+
6074
RestRequest request = new RestRequest()
6175
{
6276
Method= Method.GET,
6377
};
6478

79+
request.AddHeader("ja3", "ja3 value"); // Set JA3 for specific request
80+
6581
/* You can use all features of RestRequest object | For more information look examples */
6682

6783
var response= await restClient.ExecuteCycleAsync(request, cycleClient);
6884
```
6985
## Files you use
7086

7187
* CylceTLS
72-
* [CycleRequestOptions](https://github.com/ErenKrt/CycleTLS.NET/blob/main/CycleTLS/CycleTLS/Models/CycleRequestOptions.cs)
73-
* [RestCyleExtensions](https://github.com/ErenKrt/CycleTLS.NET/blob/main/CycleTLS/Example.RestSharp/Example.RestSharp.csproj)
88+
* [CycleRequestOptions](https://github.com/ErenKrt/CycleTLS.NET/blob/main/src/CycleTLS/Models/CycleRequestOptions.cs)
89+
* [RestCyleExtensions](https://github.com/ErenKrt/CycleTLS.NET/blob/main/src/CycleTLS.RestSharp/Helpers/RestCyleExtensions.cs)
90+
91+
[![Developer](https://img.shields.io/badge/-Developer-E4405F?style=flat-square&logo=Instagram&logoColor=white)](https://www.instagram.com/ep.eren)

examples/Example.RestSharp/Program.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
BaseUrl = new Uri("https://example.org"),
1616
//Proxy= proxy
1717
});
18+
restClient.AddDefaultHeader("ja3", "ja3 value");
1819
/*
1920
RestRequest getRequest = new RestRequest()
2021
{

src/CycleTLS.RestSharp/CycleTLS.RestSharp.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<ImplicitUsings>enable</ImplicitUsings>
66
<Nullable>enable</Nullable>
77
<Title>CycleTLS.RestSharp</Title>
8-
<Version>0.1.6</Version>
8+
<Version>0.1.8</Version>
99
<Authors>ErenKrt</Authors>
1010
<PackageProjectUrl>https://github.com/ErenKrt/CycleTLS.NET</PackageProjectUrl>
1111
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>

src/CycleTLS/CycleTLS - Backup.csproj

Lines changed: 0 additions & 22 deletions
This file was deleted.

src/CycleTLS/CycleTLS.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<Title>CycleTLS</Title>
99
<Authors>ErenKrt</Authors>
1010
<PackageProjectUrl>https://github.com/ErenKrt/CycleTLS.NET</PackageProjectUrl>
11-
<Version>0.1.6</Version>
11+
<Version>0.1.8</Version>
1212
<Description>A C# port of CycleTLS Go library.</Description>
1313
<PackageReadmeFile>README.md</PackageReadmeFile>
1414
<PackageLicenseFile>LICENSE</PackageLicenseFile>

0 commit comments

Comments
 (0)