diff --git a/README.md b/README.md index fa5fc1a7dba..6f4788e5bb1 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,17 @@ [![GitHub pull-requests closed](https://img.shields.io/github/issues-pr-closed/prebid/prebid-server-java.svg)](https://GitHub.com/prebid/prebid-server-java/pull/) Prebid Server is an open source implementation of Server-Side Header Bidding. -It is managed by [Prebid.org](http://prebid.org/overview/what-is-prebid-org.html), -and upholds the principles from the [Prebid Code of Conduct](http://prebid.org/wrapper_code_of_conduct.html). +It is managed by Prebid.org, +and upholds the principles from the [Prebid Code of Conduct](https://prebid.org/wrapper_code_of_conduct.html). This project does not support the same set of Bidders as Prebid.js, although there is overlap. The current set can be found in the [adapters](./src/main/java/org/prebid/server/bidder) package. If you don't see the one you want, feel free to [contribute it](docs/developers/add-new-bidder.md). For more information, see: -- [What is Prebid?](http://prebid.org/overview/intro.html) -- [Getting started with Prebid Server](http://prebid.org/dev-docs/get-started-with-prebid-server.html) -- [Current Bidders](http://prebid.org/dev-docs/prebid-server-bidders.html) +- [What is Prebid?](https://prebid.org/why-prebid/) +- [Getting started with Prebid Server](https://docs.prebid.org/prebid-server/overview/prebid-server-overview.html) +- [Current Bidders](https://docs.prebid.org/dev-docs/pbs-bidders.html) # Getting Started @@ -28,16 +28,14 @@ The server makes the following assumptions: - No ranking or decisioning is performed by this server. It just proxies requests. - No ad quality management (e.g., malware, viruses, deceptive creatives) is performed by this server. - This server does no fraud scanning and does nothing to prevent bad traffic. -- This server does no logging. -- This server has not user profiling or user data collection capabilities. +- This server logs errors but not requests. +- This server has no user profiling or user data collection capabilities. This project is built upon [Vert.x](http://vertx.io) to achieve high request throughput. We use [Maven](https://maven.apache.org) and attempt to introduce minimal dependencies. When running, the server responds to several HTTP [endpoints](docs/endpoints). -To start the Prebid Server you need to do the following steps: - ## Building Follow next steps to create JAR file which can be deployed locally. @@ -84,7 +82,6 @@ and verify response status is `200 OK`. # Documentation ## Development -- [Differences Between Prebid Server Go and Java](docs/differenceBetweenPBSGo-and-Java.md) - [Endpoints](docs/endpoints) - [Adding new bidder](docs/developers/add-new-bidder.md) - [Adding new analytics module](docs/developers/add-new-analytics-module.md)