Skip to content

changed ReadMe #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JonSnowWhite merged 1 commit into from
Jun 9, 2021
Merged

changed ReadMe #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Modifiable variable allows one to set modifications to basic types after or before their values are actually determined. When their actual values are determined and one tries to access the value via getters, the original value will be returned in a modified form accordingly.

#Installation
# Installation

In order to compile and use ModifiableVariable, you need to have Java and Maven installed. On Ubuntu you can install
Maven by running:
Expand All @@ -31,7 +31,7 @@ If you want to use this project as a dependency, you do not have to compile it y
</dependency>
```

#Usage
# Usage

The best way to present the functionality of ModifiableVariables is by means of a simple example:

Expand All @@ -57,15 +57,6 @@ ba.setModification(modifier);
System.out.println(ArrayConverter.bytesToHexString(ba)); // 01 02 03 04
```

If you want to use modifiable variables in your maven projects, you can include the following dependency in your pom file:
```xml
<dependency>
<groupId>de.rub.nds</groupId>
<artifactId>ModifiableVariable</artifactId>
<version>3.0.0</version>
</dependency>
```

# Supported data types
The following modifiable variables are provided in this package with their modifications:
* ModifiableBigInteger: add, explicitValue, shiftLeft, shiftRight, subtract, xor
Expand Down