Skip to content

Commit 0f8ec3f

Browse files
committed
Run prettier on the README
This adds a bunch of whitespace around section headings but doesn’t change the output
1 parent 2b7002e commit 0f8ec3f

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,24 @@
1010
[//]: # (see https://github.com/moznion/javadocio-badges for automatic javadoc)
1111

1212
## Description
13+
1314
The BAGIT LIBRARY is a software library intended to support the creation,
1415
manipulation, and validation of bags. Its current version is 0.97. It is version aware with the earliest
1516
supported version being 0.93.
1617

1718
## Requirements
18-
* Java 8
19-
* gradle (for development only)
19+
20+
- Java 8
21+
- gradle (for development only)
2022

2123
## Support
22-
1. The Digital Curation Google Group (https://groups.google.com/d/forum/digital-curation) is an open discussion list that reaches many of the contributors to and users of this open-source project
23-
2. If you have found a bug please create a new issue on [the issues page](https://github.com/LibraryOfCongress/bagit-java/issues/new)
24-
3. If you would like to contribute, please submit a [pull request](https://help.github.com/articles/creating-a-pull-request/)
2524

26-
## Major differences between version 5 and 4.*
25+
1. The Digital Curation Google Group (https://groups.google.com/d/forum/digital-curation) is an open discussion list that reaches many of the contributors to and users of this open-source project
26+
2. If you have found a bug please create a new issue on [the issues page](https://github.com/LibraryOfCongress/bagit-java/issues/new)
27+
3. If you would like to contribute, please submit a [pull request](https://help.github.com/articles/creating-a-pull-request/)
28+
29+
## Major differences between version 5 and 4.\*
30+
2731
##### Command Line Interface
2832

2933
The 5.x versions do not include a command-line interface.
@@ -34,6 +38,7 @@ or switch to an alternative implementation such as
3438
[BagIt for Ruby](https://github.com/tipr/bagit).
3539

3640
##### Serialization
41+
3742
Starting with the 5.x versions bagit-java no longer supports directly
3843
serializing a bag to an archive file. The examples show how to implement a
3944
custom serializer for the
@@ -43,15 +48,17 @@ and
4348
formats.
4449

4550
##### Fetching
51+
4652
The 5.x versions do not include a core `fetch.txt` implementation. If you need
4753
this functionality, the
4854
[`FetchHttpFileExample` example](https://github.com/LibraryOfCongress/bagit-java/blob/master/src/test/java/gov/loc/repository/bagit/examples/fetching/FetchHttpFileExample.java)
4955
demonstrates how you can implement this feature with your additional application
5056
and workflow requirements.
5157

5258
##### Internationalization
53-
All logging and error messages have been put into a [ResourceBundle](https://docs.oracle.com/javase/7/docs/api/java/util/ResourceBundle.html).
54-
This allows for all the messages to be translated to multiple languages and automatically used during runtime.
59+
60+
All logging and error messages have been put into a [ResourceBundle](https://docs.oracle.com/javase/7/docs/api/java/util/ResourceBundle.html).
61+
This allows for all the messages to be translated to multiple languages and automatically used during runtime.
5562
If you would like to contribute to translations please visit https://www.transifex.com/acdha/bagit-java/dashboard/ or https://crowdin.com/project/bagit-java.
5663

5764
##### New Interfaces
@@ -62,6 +69,7 @@ to follow modern Java practices and will require some changes to existing code:
6269
### Examples of using the new bagit-java library
6370

6471
##### Create a bag from a folder using version 0.97
72+
6573
```java
6674
Path folder = Paths.get("FolderYouWantToBag");
6775
StandardSupportedAlgorithms algorithm = StandardSupportedAlgorithms.MD5;
@@ -70,33 +78,38 @@ Bag bag = BagCreator.bagInPlace(folder, Arrays.asList(algorithm), includeHiddenF
7078
```
7179

7280
##### Read an existing bag (version 0.93 and higher)
81+
7382
```java
7483
Path rootDir = Paths.get("RootDirectoryOfExistingBag");
7584
BagReader reader = new BagReader();
7685
Bag bag = reader.read(rootDir);
7786
```
7887

7988
##### Write a Bag object to disk
89+
8090
```java
8191
Path outputDir = Paths.get("WhereYouWantToWriteTheBagTo");
8292
BagWriter.write(bag, outputDir); //where bag is a Bag object
8393
```
8494

8595
##### Verify Complete
96+
8697
```java
8798
boolean ignoreHiddenFiles = true;
8899
BagVerifier verifier = new BagVerifier();
89100
verifier.isComplete(bag, ignoreHiddenFiles);
90101
```
91102

92103
##### Verify Valid
104+
93105
```java
94106
boolean ignoreHiddenFiles = true;
95107
BagVerifier verifier = new BagVerifier();
96108
verifier.isValid(bag, ignoreHiddenFiles);
97109
```
98110

99111
##### Quickly verify by payload-oxum
112+
100113
```java
101114
boolean ignoreHiddenFiles = true;
102115

@@ -158,25 +171,33 @@ List<BagitWarning> warnings = linter.lintBag(rootDir, Arrays.asList(BagitWarning
158171
```
159172

160173
## Developing Bagit-Java
174+
161175
Bagit-Java uses [Gradle](https://gradle.org/) for its build system. Check out the great [documentation](https://docs.gradle.org/current/userguide/userguide_single.html) to learn more.
176+
162177
##### Running tests and code quality checks
178+
163179
Inside the bagit-java root directory, run `./gradlew check`.
180+
164181
##### Uploading to maven central
165182
1. Follow their guides
166183
1. http://central.sonatype.org/pages/releasing-the-deployment.html
167184
2. https://issues.sonatype.org/secure/Dashboard.jspa
168185
2. Once you have access, to create an official release and upload it you should specify the version by running `./gradlew -Pversion=<VERSION> uploadArchives`
169186
1. *Don't forget to tag the repository!*
170187
188+
171189
##### Uploading to jcenter
172190
1. Follow their guide
173191
1. https://github.com/bintray/bintray-examples/tree/master/gradle-bintray-plugin-examples
174192
2. Once you have access, to create an official release and upload it you should specify the version by running `./gradlew -Pversion=<VERSION> bintrayUpload`
175193
1. *Don't forget to tag the repository!*
176194

195+
177196
### Note if using with Eclipse
197+
178198
Simply run `./gradlew eclipse` and it will automatically create a eclipse project for you that you can import.
179199

180200
### Roadmap for this library
181201
* Fix bugs/issues reported with new library (on going)
182202
* Translate to various languages (on going)
203+

0 commit comments

Comments
 (0)