summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2020-05-07 13:44:01 +0200
committerDr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com>2020-05-08 16:22:02 +0200
commit257e9d03b028402089c9f98f3acb25ba668c09af (patch)
treedfdaf8c1ca2a6ec6960c84e8bfe398f701ce9a18 /README.md
parent4ef0ddc9d8ee829bf9dceae73f7a48a55f512739 (diff)
Fix issues reported by markdownlint
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/11739)
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 24 insertions, 34 deletions
diff --git a/README.md b/README.md
index 98a07f7f70..e566d3161c 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,11 @@
+Welcome to the OpenSSL Project
+==============================
+
[![openssl logo][]][www.openssl.org]
[![travis badge][]][travis jobs]
[![appveyor badge][]][appveyor jobs]
-
-
-Welcome to the OpenSSL Project
-==============================
-
OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit
for the Transport Layer Security (TLS) protocol formerly known as the
Secure Sockets Layer (SSL) protocol. The protocol implementation is based
@@ -19,7 +17,6 @@ and Tim J. Hudson.
The official Home Page of the OpenSSL Project is [www.openssl.org][].
-
Table of Contents
=================
@@ -47,13 +44,13 @@ The OpenSSL toolkit includes:
- **openssl**
the OpenSSL command line tool, a swiss army knife for cryptographic tasks,
testing and analyzing. It can be used for
- - creation of key parameters
- - creation of X.509 certificates, CSRs and CRLs
- - calculation of message digests
- - encryption and decryption
- - SSL/TLS client and server tests
- - handling of S/MIME signed or encrypted mail
- - and more...
+ - creation of key parameters
+ - creation of X.509 certificates, CSRs and CRLs
+ - calculation of message digests
+ - encryption and decryption
+ - SSL/TLS client and server tests
+ - handling of S/MIME signed or encrypted mail
+ - and more...
Download
========
@@ -70,7 +67,6 @@ of the OpenSSL toolkit are available. In particular on Linux and other
Unix operating systems it is normally recommended to link against the
precompiled shared libraries provided by the distributor or vendor.
-
For Testing and Development
---------------------------
@@ -86,22 +82,21 @@ which is updated automatically from the former on every commit.
A local copy of the Git Repository can be obtained by cloning it from
the original OpenSSL repository using
- git clone git://git.openssl.org/openssl.git
+ git clone git://git.openssl.org/openssl.git
or from the GitHub mirror using
- git clone https://github.com/openssl/openssl.git
+ git clone https://github.com/openssl/openssl.git
If you intend to contribute to OpenSSL, either to fix bugs or contribute
new features, you need to fork the OpenSSL repository openssl/openssl on
GitHub and clone your public fork instead.
- git clone https://github.com/yourname/openssl.git
+ git clone https://github.com/yourname/openssl.git
This is necessary, because all development of OpenSSL nowadays is done via
GitHub pull requests. For more details, see [Contributing](#contributing).
-
Build and Install
=================
@@ -166,7 +161,6 @@ platform. The OpenSSL Project Pages at [openssl.github.io][] are a
valuable source of information if you want to get familiar with our
development process on GitHub.
-
Legalities
==========
@@ -174,7 +168,6 @@ A number of nations restrict the use or export of cryptography. If you are
potentially subject to such restrictions you should seek legal advice before
attempting to develop or distribute cryptographic code.
-
Copyright
=========
@@ -184,37 +177,34 @@ Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
All rights reserved.
-
<!-- Links -->
[www.openssl.org]:
- https://www.openssl.org
+ <https://www.openssl.org>
"OpenSSL Homepage"
[git.openssl.org]:
- https://git.openssl.org
+ <https://git.openssl.org>
"OpenSSL Git Repository"
[git.openssl.org]:
- https://git.openssl.org
+ <https://git.openssl.org>
"OpenSSL Git Repository"
[github.com/openssl/openssl]:
- https://github.com/openssl/openssl
+ <https://github.com/openssl/openssl>
"OpenSSL GitHub Mirror"
[openssl.github.io]:
- https://mspncp.github.io
+ <https://mspncp.github.io>
"OpenSSL Project Pages"
[wiki.openssl.org]:
- https://wiki.openssl.org
+ <https://wiki.openssl.org>
"OpenSSL Wiki"
-
[RFC 8446]:
- https://tools.ietf.org/html/rfc8446
-
+ <https://tools.ietf.org/html/rfc8446>
<!-- Logos and Badges -->
<!--
@@ -230,17 +220,17 @@ All rights reserved.
"OpenSSL Logo"
[travis badge]:
- https://travis-ci.org/openssl/openssl.svg?branch=master
+ <https://travis-ci.org/openssl/openssl.svg?branch=master>
"Travis Build Status"
[travis jobs]:
- https://travis-ci.org/openssl/openssl
+ <https://travis-ci.org/openssl/openssl>
"Travis Jobs"
[appveyor badge]:
- https://ci.appveyor.com/api/projects/status/ikn2l4u1xsume63u/branch/master?svg=true
+ <https://ci.appveyor.com/api/projects/status/ikn2l4u1xsume63u/branch/master?svg=true>
"AppVeyor Build Status"
[appveyor jobs]:
- https://ci.appveyor.com/project/openssl/openssl/branch/master
+ <https://ci.appveyor.com/project/openssl/openssl/branch/master>
"AppVeyor Jobs"