diff --git a/README.md b/README.md new file mode 100644 index 000000000..8a1fd4efb --- /dev/null +++ b/README.md @@ -0,0 +1,97 @@ + +Apache HttpComponents Client +============================ + +Welcome to the HttpClient component of the Apache HttpComponents project. + +[![Build Status](https://travis-ci.com/apache/httpcomponents-client.svg?branch=master)](https://travis-ci.com/apache/httpcomponents-client) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +Building Instructions +--------------------- + +For building from source instructions please refer to [BUILDING.txt](./BUILDING.txt). + +Dependencies +------------ + +HttpClient main module requires Java 7 compatible runtime and +depends on the following external libraries: + +* [Apache HttpComponents HttpCore](https://github.com/apache/httpcomponents-core) +* [Apache Logging Log4j2 API](https://github.com/apache/logging-log4j2) +* [Apache Commons Codec](https://github.com/apache/commons-codec) + +Other dependencies are optional. + +(for detailed information on external dependencies please see [pom.xml](./pom.xml)) + +Licensing +--------- + +Apache HttpComponents Client is licensed under the Apache License 2.0. +See the files [LICENSE.txt](./LICENSE.txt) and [NOTICE.txt](./NOTICE.txt) for more information. + +Contact +------- + +- For general information visit the main project site at + https://hc.apache.org/ +- For current status information visit the status page at + https://hc.apache.org/status.html +- If you want to contribute visit + https://hc.apache.org/get-involved.html + +Cryptographic Software Notice +----------------------------- + +This distribution may include software that has been designed for use +with cryptographic software. The country in which you currently reside +may have restrictions on the import, possession, use, and/or re-export +to another country, of encryption software. BEFORE using any encryption +software, please check your country's laws, regulations and policies +concerning the import, possession, or use, and re-export of encryption +software, to see if this is permitted. See https://www.wassenaar.org/ +for more information. + +The U.S. Government Department of Commerce, Bureau of Industry and +Security (BIS), has classified this software as Export Commodity +Control Number (ECCN) 5D002.C.1, which includes information security +software using or performing cryptographic functions with asymmetric +algorithms. The form and manner of this Apache Software Foundation +distribution makes it eligible for export under the License Exception +ENC Technology Software Unrestricted (TSU) exception (see the BIS +Export Administration Regulations, Section 740.13) for both object +code and source code. + +The following provides more details on the included software that +may be subject to export controls on cryptographic software: + +> Apache HttpComponents Client interfaces with the +> Java Secure Socket Extension (JSSE) API to provide +> - HTTPS support +> +> Apache HttpComponents Client does not include any +> implementation of JSSE. diff --git a/README.txt b/README.txt deleted file mode 100644 index bf8295fe4..000000000 --- a/README.txt +++ /dev/null @@ -1,71 +0,0 @@ -Apache HttpComponents Client -============================ - -Welcome to the HttpClient component of the Apache HttpComponents project. - -Building Instructions ---------------------- - -For building from source instructions please refer to BUILDING.txt. - -Dependencies ------------- - -HttpClient main module requires Java 7 compatible runtime and -depends on the following external libraries: - -* Apache HttpComponents HttpCore -* Apache Logging Log4j2 API -* Apache Commons Codec - -Other dependencies are optional. - -(for detailed information on external dependencies please see pom.xml) - -Licensing ---------- - -Apache HttpComponents Client is licensed under the Apache License 2.0. -See the files called LICENSE.txt and NOTICE.txt for more information. - -Cryptographic Software Notice ------------------------------ - -This distribution may include software that has been designed for use -with cryptographic software. The country in which you currently reside -may have restrictions on the import, possession, use, and/or re-export -to another country, of encryption software. BEFORE using any encryption -software, please check your country's laws, regulations and policies -concerning the import, possession, or use, and re-export of encryption -software, to see if this is permitted. See -for more information. - -The U.S. Government Department of Commerce, Bureau of Industry and -Security (BIS), has classified this software as Export Commodity -Control Number (ECCN) 5D002.C.1, which includes information security -software using or performing cryptographic functions with asymmetric -algorithms. The form and manner of this Apache Software Foundation -distribution makes it eligible for export under the License Exception -ENC Technology Software Unrestricted (TSU) exception (see the BIS -Export Administration Regulations, Section 740.13) for both object -code and source code. - -The following provides more details on the included software that -may be subject to export controls on cryptographic software: - - Apache HttpComponents Client interfaces with the - Java Secure Socket Extension (JSSE) API to provide - - - HTTPS support - - Apache HttpComponents Client does not include any - implementation of JSSE. - -Contact -------- - - o For general information visit the main project site at - http://hc.apache.org/ - - o For current status information visit the status page at - http://hc.apache.org/status.html