ctubbsii commented on a change in pull request #1: Provide initial README
File path: README.md
@@ -0,0 +1,102 @@
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+# Apache Fluo Bytes
+[![Build Status][ti]][tl] [![Apache License][li]][ll] [![Maven
+**Apache Fluo Bytes is an API project with the goal of providing an extremely
+stable library for handling bytes, suitable for use in [Apache Fluo][fluo] and
+other projects' APIs.**
+## Features and Goals
+This project aims to fill a void in Java, by providing convenient objects to
+represent a string of bytes and associated utility classes for situations when
+a raw byte array is not appropriate.
I did try to write more on this initially, but everything I came up with was
too long and seemed to drift off topic.
I boiled it down to what you see here, mentioning this library is useful
when byte arrays aren't appropriate, and then immediately following that
statement by some of the features that make it so, naming all of the things you
list here. I don't know that I'd really want more details in the README than
that. I certainly don't want to repeat a blog post, or make the README a big
wall of text that provides so many details, it's hard to get the gist.
But, if you have specific suggestions which can improve this, I'm happy to
work it in. I, however, am near my editing limit on this subject. :)
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
Apache Git Services