Readme should be similar to the welcome page, not contributing.md! My bad
tal
parent
3abb2dd204
commit
3a2979ca81
|
|
@ -1,73 +1,3 @@
|
|||
# Welcome to DuckDuckHack's Goodies Instant Answers Repository
|
||||
# Contributing an Instant Answer
|
||||
|
||||
|
||||
|
||||
**Instant Answers are an opportunity for anyone to create their own search results.**
|
||||
|
||||
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 you. Welcome!
|
||||
|
||||
You can find the [full documentation here](http://docs.duckduckhack.com). This is the repository for [one type of Instant Answers](http://docs.duckduckhack.com/welcome/determining-ia-type.html), called Goodies.
|
||||
|
||||
## Create a New Instant Answer
|
||||
|
||||
Learn to make an Instant Answer by starting with any of our quick tutorials. All of these are self-contained and will get you up and running. Pick whatever looks most interesting!
|
||||
|
||||
- **[Create a programming syntax cheat sheet](http://docs.duckduckhack.com/walkthroughs/programming-syntax.html)**
|
||||
- **[Create a quick online calculation](http://docs.duckduckhack.com/walkthroughs/calculation.html)**
|
||||
- **[Build an API-based lookup](http://docs.duckduckhack.com/walkthroughs/forum-lookup.html)**
|
||||
|
||||
## Improve a Live Instant Answer
|
||||
|
||||
We welcome new contributors to dive in and improve live Instant Answers. It's a great, hands-on way to learn how things work. Start by [setting up your development environment](http://docs.duckduckhack.com/welcome/setup-dev-environment.html).
|
||||
|
||||
You can see all "low-hanging fruit" issues neatly organized in one place on our [Live Issues Page](https://duck.co/ia/dev/issues?tag=lowhangingfruit), or get an overview of all [Instant Answers in development](https://duck.co/ia/dev/pipeline).
|
||||
|
||||
Have a [favorite Instant Answer](http://duck.co/ia) that you want to make even better? Feel free to dive in and make changes.
|
||||
|
||||
## Inspiration
|
||||
|
||||
Instant Answers allow you to create your own search results. 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...
|
||||
|
||||
|
||||
|
||||
...or simply convenient:
|
||||
|
||||
|
||||
|
||||
Some are just cool:
|
||||
|
||||
|
||||
|
||||
Many are absolutely delightful and unexpected:
|
||||
|
||||
|
||||
|
||||
Many are super practical...
|
||||
|
||||
|
||||
|
||||
...in ways we never imagined:
|
||||
|
||||
|
||||
|
||||
Some Instant Answers are built from pure code:
|
||||
|
||||
|
||||
|
||||
Other Instant Answers channel external sources (API requests):
|
||||
|
||||
|
||||
|
||||
The [possibilities are endless](https://duck.co/ia). **Our community's mission is to cover every topic with a community-generated Instant Answer.**
|
||||
|
||||
## Discuss with Us
|
||||
|
||||
Want help? Need to think out loud?
|
||||
|
||||
[ Talk to us on Slack](mailto:QuackSlack@duckduckgo.com?subject=AddMe) or [email us](mailto:open@duckduckgo.com).
|
||||
|
||||
We're a digital community, but real people - we frequently meet up to hack together. Check out our [global meetups](http://duckduckgo.meetup.com/).
|
||||
|
||||
You can find the [full documentation here](http://docs.duckduckhack.com).
|
||||
An overview of how to submit an Instant Answer can [be found over in our docs](http://docs.duckduckhack.com/submitting/submitting-overview.html).
|
||||
74
README.md
74
README.md
|
|
@ -1,13 +1,73 @@
|
|||
# DuckDuckHack Goodies [](https://travis-ci.org/duckduckgo/zeroclickinfo-goodies)
|
||||
# Welcome to DuckDuckHack's Goodies Instant Answers Repository
|
||||
|
||||
Join us on Slack! [Request invite](mailto:QuackSlack@duckduckgo.com?subject=AddMe)
|
||||
|
||||
|
||||
This repository contains all the Goodie instant answers. If you are developing a Goodie instant answer you will need to fork this repository.
|
||||
**Instant Answers are an opportunity for anyone to create their own search results.**
|
||||
|
||||
**If you would like to contribute to DuckDuckHack, please start by reading the [DuckDuckHack Documentation](https://dukgo.com/duckduckhack/ddh-intro).**
|
||||
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 you. Welcome!
|
||||
|
||||
------
|
||||
You can find the [full documentation here](http://docs.duckduckhack.com). This is the repository for [one type of Instant Answers](http://docs.duckduckhack.com/welcome/determining-ia-type.html), called Goodies.
|
||||
|
||||
### Goodie Instant Answer Example
|
||||
## Create a New Instant Answer
|
||||
|
||||
|
||||
Learn to make an Instant Answer by starting with any of our quick tutorials. All of these are self-contained and will get you up and running. Pick whatever looks most interesting!
|
||||
|
||||
- **[Create a programming syntax cheat sheet](http://docs.duckduckhack.com/walkthroughs/programming-syntax.html)**
|
||||
- **[Create a quick online calculation](http://docs.duckduckhack.com/walkthroughs/calculation.html)**
|
||||
- **[Build an API-based lookup](http://docs.duckduckhack.com/walkthroughs/forum-lookup.html)**
|
||||
|
||||
## Improve a Live Instant Answer
|
||||
|
||||
We welcome new contributors to dive in and improve live Instant Answers. It's a great, hands-on way to learn how things work. Start by [setting up your development environment](http://docs.duckduckhack.com/welcome/setup-dev-environment.html).
|
||||
|
||||
You can see all "low-hanging fruit" issues neatly organized in one place on our [Live Issues Page](https://duck.co/ia/dev/issues?tag=lowhangingfruit), or get an overview of all [Instant Answers in development](https://duck.co/ia/dev/pipeline).
|
||||
|
||||
Have a [favorite Instant Answer](http://duck.co/ia) that you want to make even better? Feel free to dive in and make changes.
|
||||
|
||||
## Inspiration
|
||||
|
||||
Instant Answers allow you to create your own search results. 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...
|
||||
|
||||
|
||||
|
||||
...or simply convenient:
|
||||
|
||||
|
||||
|
||||
Some are just cool:
|
||||
|
||||
|
||||
|
||||
Many are absolutely delightful and unexpected:
|
||||
|
||||
|
||||
|
||||
Many are super practical...
|
||||
|
||||
|
||||
|
||||
...in ways we never imagined:
|
||||
|
||||
|
||||
|
||||
Some Instant Answers are built from pure code:
|
||||
|
||||
|
||||
|
||||
Other Instant Answers channel external sources (API requests):
|
||||
|
||||
|
||||
|
||||
The [possibilities are endless](https://duck.co/ia). **Our community's mission is to cover every topic with a community-generated Instant Answer.**
|
||||
|
||||
## Discuss with Us
|
||||
|
||||
Want help? Need to think out loud?
|
||||
|
||||
[ Talk to us on Slack](mailto:QuackSlack@duckduckgo.com?subject=AddMe) or [email us](mailto:open@duckduckgo.com).
|
||||
|
||||
We're a digital community, but real people - we frequently meet up to hack together. Check out our [global meetups](http://duckduckgo.meetup.com/).
|
||||
|
||||
You can find the [full documentation here](http://docs.duckduckhack.com).
|
||||
Loading…
Reference in New Issue