/README.md

https://github.com/duckduckgo/php5-duckduckgo · Markdown · 32 lines · 27 code · 5 blank · 0 comment · 0 complexity · 05ea983ffb9d30d04cdb01b5bcaf9042 MD5 · raw file 

    

  1. The DuckDuckGo PHP5 API
    2. 

  2. =======================
    3. 

  3. 

  4. Notes
    5. 

  5. -----
    6. 

  6. - This API requires PHP *v5.3* or higher, due to the use of namespaces.
    7. 

  7.   A namespaceless version will be available later.
    8. 

  8. - This API is still *experimental* - please report any and all bugs using the ticket system.
    9. 

  9. 

  10. Usage
    11. 

  11. -----
    12. 

  12. To use the DuckDuckGo PHP5 API in your application, include DuckDuckGo/API.php where you want
    13. 

  13. to use the API, create a new instance of the DuckDuckGo\API class, and use it to improve the world!
    14. 

  14. 

  15. Example
    16. 

  16. -------
    17. 

  17.     <?php
    18. 

  18.     require_once('DuckDuckGo/API.php');
    19. 

  19.     $api = new DuckDuckGo\API();
    20. 

  20.     $api->secure = TRUE;
    21. 

  21.     $ircInfo = $api->zeroClickQuery('Internet Relay Chat');
    22. 

  22.     echo $ircInfo->definition;
    23. 

  23. 

  24. Documentation
    25. 

  25. -------------
    26. 

  26. Due the use of JavaDoc, documentation can easily be generated from the files using e.g. Doxygen.
    27. 

  27. A pre-generated version of the documentation will be supplied in the near future.
    28. 

  28. 

  29. Comments?
    30. 

  30. ---------
    31. 

  31. Hit me up a message, or file a ticket! :)
    32. 

  32. For quicker response, try catching me on IRC on `#duckduckgo @ irc.freenode.net`.
    33.