diff --git a/README.md b/README.md index ecad3a36..cf784666 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,44 @@
- Httpie-Logo-Lockup-Pink@2x + HTTPie +
-# HTTPie: the human-friendly HTTP CLI client for working with APIs +# HTTPie: human-friendly CLI HTTP client for the API era - +HTTPie (pronounced _aitch-tee-tee-pie_) is a command-line HTTP client. +Its goal is to make CLI interaction with web services as human-friendly as possible. +HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers. +The `http` & `https` commands allow for creating and sending arbitrary HTTP requests. +They use simple and natural syntax and provide formatted and colorized output. -[![Build](https://img.shields.io/github/workflow/status/httpie/httpie/Build?color=%2373DC8C&label=Build&logo=github)](https://github.com/httpie/httpie/actions) -[![Latest version](https://img.shields.io/pypi/v/httpie.svg?style=flat&label=Latest%20stable%20version&color=%23FA9BFA&logo=pypi&logoColor=white)](https://pypi.python.org/pypi/httpie) -[![Coverage](https://img.shields.io/codecov/c/github/httpie/httpie?style=flat&label=Coverage&color=%237D7D7D&logo=codecov)](https://codecov.io/gh/httpie/httpie) -[![Downloads](https://img.shields.io/pypi/dm/httpie?color=%23DBDE52&label=Downloads&logo=python)](https://pepy.tech/project/httpie) +[![Docs](https://img.shields.io/badge/stable%20docs-httpie.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://httpie.org/docs) +[![Latest version](https://img.shields.io/pypi/v/httpie.svg?style=flat&label=Latest&color=%234B78E6&logo=&logoColor=white)](https://pypi.python.org/pypi/httpie) +[![Build](https://img.shields.io/github/workflow/status/httpie/httpie/Build?color=%23FA9BFA&label=Build)](https://github.com/httpie/httpie/actions) +[![Coverage](https://img.shields.io/codecov/c/github/httpie/httpie?style=flat&label=Coverage&color=%2373DC8C)](https://codecov.io/gh/httpie/httpie) +[![Twitter](https://img.shields.io/twitter/follow/httpie?style=flat&color=%234B78E6&logoColor=%234B78E6)](https://twitter.com/httpie) +[![Chat](https://img.shields.io/badge/chat-Discord-brightgreen?style=flat&label=Chat%20on&color=%23FA9BFA)](https://httpie.io/chat) -[![Issues](https://img.shields.io/github/issues/httpie/httpie?style=flat&color=%23FFA24E&label=Issues&logo=github)](https://github.com/httpie/httpie/issues) -[![Docs](https://img.shields.io/badge/stable%20docs-httpie.org%2Fdocs-brightgreen?style=flat&color=%234B78E6&label=Stable%20docs)](https://httpie.org/docs) -[![Chat](https://img.shields.io/badge/chat-on%20Discord-brightgreen?style=flat&logo=discord&label=Chat%20on&color=%23B464F0)](https://httpie.io/chat) +HTTPie in action -HTTPie (pronounced _aitch-tee-tee-pie_ 🥧) is a command-line HTTP client. +## Getting started -The `http` and `https` commands let you send arbitrary HTTP requests for testing, debugging, and generally interacting with APIs & HTTP servers. Commands use simple, natural syntax and provide a formatted and colorized output. - -**Visit [httpie.io](https://httpie.io) to learn more** +- [Installation instructions →](https://httpie.io/docs#installation) +- [Full documentation →](https://httpie.io/docs) ## Features -- Simple syntax +- Expressive and intuitive syntax - Formatted and colorized terminal output - Built-in JSON support - Forms and file uploads - HTTPS, proxies, and authentication +- Arbitrary request data +- Custom headers - Persistent sessions -- Wget-like downloads -- Linux, macOS and Windows support -- Plugins, such as JWTAuth and OAuth +- `wget`-like downloads -See the [complete list of features](https://httpie.io/docs). - -## Documentation - -Full documentation and installation guides live in [httpie.io/docs](https://httpie.io/docs). - -## Installation - -HTTPie can be installed using Homebrew on macOS (`brew install httpie`), and `pip` on Linux, Windows and other Operating Systems (e.g. `python -m pip install --upgrade httpie`). - -See the [docs](https://httpie.io/docs) for system requirements and full installation instructions. +[See for all features →](https://httpie.io/docs) ## Examples @@ -72,34 +66,19 @@ Use [GitHub API](https://developer.github.com/v3/issues/comments/#create-a-comme $ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:' ``` -**See [the documentation](https://httpie.io/docs) for a complete list of examples and use cases.** +[See more examples →](https://httpie.io/docs#examples) + +## Community & support + +- Visit the [HTTPie website](https://httpie.io) for full documentation and useful links. +- Join our [Discord server](https://httpie.io/chat) is to ask questions, discuss features, and for general API chat. +- Tweet at [@httpie](https://twitter.com/httpie) on Twitter. +- Use [StackOverflow](https://stackoverflow.com/questions/tagged/httpie) to ask questions and include a `httpie` tag. +- Create [GitHub Issues](https://github.com/httpie/httpie/issues) for bug reports and feature requests. +- Subscribe to the [HTTPie newsletter](https://httpie.io) for occasional updates. ## Contributing -We :sparkling_heart: our contributors! Please read the [contribution guide](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md) for how to contribute. -Have a look through existing [Issues](https://github.com/httpie/httpie/issues) and [Pull Requests](https://github.com/httpie/httpie/pulls) that you could help with. +Have a look through existing [Issues](https://github.com/httpie/httpie/issues) and [Pull Requests](https://github.com/httpie/httpie/pulls) that you could help with. If you'd like to request a feature or report a bug, please [create a GitHub Issue](https://github.com/httpie/httpie/issues) using one of the templates provided. -[![Issues](https://img.shields.io/github/issues/httpie/httpie?style=flat&color=%23FFA24E&label=Issues&logo=github)](https://github.com/httpie/httpie/issues) -[![PRs](https://img.shields.io/github/issues-pr/httpie/httpie?color=%23FA9BFA&label=Pull%20Requests&logo=github)](https://github.com/httpie/httpie/pulls) - -If you'd like to request a feature or report a bug, please [create a GitHub Issue](https://github.com/httpie/httpie/issues) using one of the templates provided. - -## Community & Support - -- Visit the [HTTPie website](https://httpie.io) for full documentation and useful links. - -- Join our [Discord server](https://httpie.io/chat) is to ask questions, discuss features, and for general API chat. - -- Tweet at [@httpie](https://twitter.com/httpie) on Twitter. - -- Use [StackOverflow](https://stackoverflow.com/questions/tagged/httpie) to ask questions and include a `httpie` tag. - -- Create [GitHub Issues](https://github.com/httpie/httpie/issues) for bug reports and feature requests. - -- Subscribe to the [HTTPie newsletter](https://httpie.io) for occasional updates. - -## License - -[![License](https://img.shields.io/github/license/httpie/httpie?color=%2373DC8C&label=License)](https://github.com/httpie/httpie/blob/master/LICENSE) - -HTTPie is licensed under the [BSD-3-Clause License](https://github.com/httpie/httpie/blob/master/LICENSE). +[See full contribution guide →](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md) diff --git a/docs/README.md b/docs/README.md index 4da6215c..010fa570 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,14 @@
- # HTTPie Documentation -
-**HTTPie (pronounced aitch-tee-tee-pie) is a command-line HTTP client. +HTTPie (pronounced _aitch-tee-tee-pie_) is a command-line HTTP client. Its goal is to make CLI interaction with web services as human-friendly as possible. HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers. -The http & https commands allow for creating and sending arbitrary HTTP requests. -They use simple and natural syntax and provide formatted and colorized output.** +The `http` & `https` commands allow for creating and sending arbitrary HTTP requests. +They use simple and natural syntax and provide formatted and colorized output. +
## About this document This documentation is best viewed at [httpie.io/docs](https://httpie.org/docs). @@ -19,6 +18,8 @@ You can select your corresponding HTTPie version as well as run examples directl If you are reading this on GitHub, then this text covers the current *development* version. You are invited to submit fixes and improvements to the docs by editing [this file](https://github.com/httpie/httpie/blob/master/docs/README.md). +
+ ## Main features - Expressive and intuitive syntax @@ -1674,7 +1675,6 @@ See [CHANGELOG](https://github.com/httpie/httpie/blob/master/CHANGELOG.md). ### Artwork -- Logo and branding by [HTTPie](https://httpie.io). - [README Animation](https://raw.githubusercontent.com/httpie/httpie/master/httpie.gif) by [Allen Smith](https://github.com/loranallensmith). ### Licence diff --git a/httpie.gif b/docs/httpie-animation.gif similarity index 100% rename from httpie.gif rename to docs/httpie-animation.gif diff --git a/docs/httpie-logo.svg b/docs/httpie-logo.svg new file mode 100644 index 00000000..4a1f5061 --- /dev/null +++ b/docs/httpie-logo.svg @@ -0,0 +1 @@ + diff --git a/httpie.png b/httpie.png deleted file mode 100644 index d87eae38..00000000 Binary files a/httpie.png and /dev/null differ