Update Goodie README for hyper-simplicity

master
Zac Pappis 2016-08-17 11:08:32 -04:00 committed by GitHub
parent 3ff75f651c
commit b0247fffd0
1 changed files with 12 additions and 61 deletions

View File

@ -1,71 +1,22 @@
# Welcome to DuckDuckHack's Goodies Instant Answers Repository
# Welcome to DuckDuckHack!
[![Build Status](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies.png?branch=master)](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies)
![](http://docs.duckduckhack.com/assets/hack search engine.png)
**We're a community dedicated to making delightful search results for everyone. We do this using existing APIs, external data sets, or just some well-placed code.**
We're a community dedicated to improving search results with open source, "Instant Answers." Instant Answers use the Web's best APIs and data to solve searches in few or zero clicks. Together and openly, we can create the best search engine for every type of search.
*Instant Answers* appear on DuckDuckGo.com above ads and organic links, on [millions of searches](https://duckduckgo.com/traffic.html). Instant Answers are created by an open source community of developers [around the world](http://duckduckgo.meetup.com/) like yourself. Welcome!
**Currently, we need help improving results for programming searches!** Your help and expertise can have a huge impact on making DuckDuckGo the best search engine for programmers.
*You can find the [full documentation here](http://docs.duckduckhack.com).*
[**Join the programming mission**](https://forum.duckduckhack.com/t/duckduckhack-programming-mission-overview/53)
## Jump Right In
More Resources:
*[Full documentation](http://docs.duckduckhack.com)*
*[Instant Answers in Production](https://duck.co/ia)*
*[Instant Answers in Beta](https://beta.duckduckgo.com/?q=test&t=hc&ia=iatesting&iax=1)*
The best way to learn about Instant Answers is to dive in with a walkthrough:
Instant Answers appear at the top of search results...
![](http://docs.duckduckhack.com/assets/python_apply_at_DuckDuckGo.png)
- Learn how to build a [convenient calculation tool](http://docs.duckduckhack.com/walkthroughs/calculation.html)
- Learn how to turn an [external API into delightful search results](http://docs.duckduckhack.com/walkthroughs/forum-lookup.html)
- Create a [cheat sheet for a favorite topic](http://docs.duckduckhack.com/walkthroughs/programming-syntax.html)
We also welcome new contributors to learn by improving existing Instant Answers:
- Tackle some of the "low-hanging fruit" and, "high priority" issues on our [Live Issues Page](https://duck.co/ia/dev/issues?tag=lowhangingfruit)
- Help other DuckDuckHackers with their [Instant Answers in development](https://duck.co/ia/dev/pipeline)
- Suggest improvements & file bugs for [live Instant Answers](https://duck.co/ia) through the, "Create Issue" button on each IA page
- Have a [favorite Instant Answer](http://duck.co/ia) that you want to make even better? Feel free to dive in and make changes.
## Say Hello
[![slack](http://docs.duckduckhack.com/assets/slack.png) You should definitely join us on Slack](https://quackslack.herokuapp.com) (you can also [email us](mailto:open@duckduckgo.com)).
P.S.We're a digital community, but real people - we frequently meet up to hack together. Check out our [global meetups](http://duckduckgo.meetup.com/).
## Live Instant Answers Made by the Community
Here are some examples of what contributors have created. You can see [all live Instant Answers listed here](https://duck.co/ia).
Instant Answers can be quite dynamic...
![](http://docs.duckduckhack.com/assets/parking_ny.png)
...or simply convenient:
![](http://docs.duckduckhack.com/assets/sales_tax.png)
Some are just cool:
![](http://docs.duckduckhack.com/assets/heads_tails.png)
Many are absolutely delightful and unexpected:
![](http://docs.duckduckhack.com/assets/bpm_ms.png)
Many are super practical...
![](http://docs.duckduckhack.com/assets/air_quality.png)
...in ways we never imagined:
![](http://docs.duckduckhack.com/assets/blue_pill.png)
Some Instant Answers are built from pure code:
![](http://docs.duckduckhack.com/assets/url_encode.png)
Other Instant Answers channel external sources (API requests):
![App search Instant Answer example](http://docs.duckduckhack.com/assets/app_search_example.png)
The [possibilities are endless](https://duck.co/ia). **Our community's mission is to cover every topic with a community-generated Instant Answer.**
Attribution is shown for developers who create or improve them...
![](http://docs.duckduckhack.com/assets/attribution_example_1.png)